Act! CRM Metadata Info API
The MetadataInfo API from Act! CRM — 14 operation(s) for metadatainfo.
The MetadataInfo API from Act! CRM — 14 operation(s) for metadatainfo.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/act-metadatainfo-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Act! Web Metadata Info API
version: v1
description: Act! Web API is a JSON-based REST API for the Act! CRM database, exposing contacts, companies, groups, opportunities, activities, notes, history and custom entities. Reads support OData query options ($filter, $orderby, $top, $skip, $select, $expand) and requests may be batched via POST /api/$batch. Authentication is a JWT bearer token obtained from GET /authorize using HTTP Basic credentials plus an Act-Database-Name header.
contact:
name: Act! Developers
url: https://www.act.com/developer/
termsOfService: https://www.act.com/legal/terms-of-service/
servers:
- url: https://apimta.act.com/act.web.api
description: Act! Premium Cloud API — US region (host and basePath as published in the provider Swagger document).
- url: https://{server}/{customer}-api/act.web.api
description: Act! Premium Cloud tenant endpoint, per the Act! Web API home page.
variables:
server:
default: apimta.act.com
customer:
default: customer
- url: https://{server}/act.web.api
description: Self-hosted Act! Premium for Web / Act! Premium Windows IIS deployment.
variables:
server:
default: localhost
security:
- bearerAuth: []
actDatabaseName: []
tags:
- name: MetadataInfo
paths:
/api/metadata/drop-down/lists/{id}:
get:
tags:
- MetadataInfo
summary: Get specific drop-down list
operationId: MetadataInfo_GetDropDownList_E02B587D
parameters:
- name: id
in: path
required: true
description: A unique identifier for a field.
schema:
type: string
responses:
'200':
description: OK indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'500':
description: Unexpected error.
put:
tags:
- MetadataInfo
summary: Update an already existing drop-down list
operationId: MetadataInfo_PutDropDownList_235230B0
parameters:
- name: id
in: path
required: true
description: The unique identifier (id) for a given drop-down list.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
description: The drop-down list definition.
responses:
'200':
description: OK indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
'400':
description: BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code.
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'404':
description: NotFound indicates that the requested resource does not exist on the server.
'500':
description: Unexpected error.
delete:
tags:
- MetadataInfo
summary: Delete an existing drop-down list
operationId: MetadataInfo_DeleteDropDownList_796D9B2D
parameters:
- name: id
in: path
required: true
description: The unique identifier (id) for a given drop-down list.
schema:
type: string
responses:
'204':
description: NoContent indicates that the request has been successfully processed and that the response is intentionally blank.
content:
application/json:
schema:
$ref: '#/components/schemas/System.Object'
application/xml:
schema:
$ref: '#/components/schemas/System.Object'
text/xml:
schema:
$ref: '#/components/schemas/System.Object'
'400':
description: BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code.
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'404':
description: NotFound indicates that the requested resource does not exist on the server.
'500':
description: Unexpected error.
/api/metadata/{recordType}/fields/{id}:
get:
tags:
- MetadataInfo
summary: Get a specific field
operationId: MetadataInfo_GetField_43A47EF1
parameters:
- name: recordType
in: path
required: true
description: Specifies the core mutable record types within the ACT! application (Company, Contact, Group, Opportunity, Product or any custom entity name).
schema:
type: string
- name: id
in: path
required: true
description: A unique identifier for a field.
schema:
type: string
responses:
'200':
description: OK indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'500':
description: Unexpected error.
put:
tags:
- MetadataInfo
summary: Update an already existing field.
operationId: MetadataInfo_PutField_E8FC57AB
parameters:
- name: id
in: path
required: true
description: The unique identifier (id) for a given field.
schema:
type: string
- name: recordType
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
description: The field to be modified.
responses:
'200':
description: OK indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
'400':
description: BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code.
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'404':
description: NotFound indicates that the requested resource does not exist on the server.
'500':
description: Unexpected error.
delete:
tags:
- MetadataInfo
summary: Delete an existing field
operationId: MetadataInfo_DeleteField_96ACDBD0
parameters:
- name: recordType
in: path
required: true
description: Specifies the core mutable record types within the ACT! application (Company, Contact, Group, Opportunity, Product or any custom entity name).
schema:
type: string
- name: id
in: path
required: true
description: The unique identifier (id) for a given drop-down list.
schema:
type: string
responses:
'204':
description: NoContent indicates that the request has been successfully processed and that the response is intentionally blank.
content:
application/json:
schema:
$ref: '#/components/schemas/System.Object'
application/xml:
schema:
$ref: '#/components/schemas/System.Object'
text/xml:
schema:
$ref: '#/components/schemas/System.Object'
'400':
description: BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code.
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'404':
description: NotFound indicates that the requested resource does not exist on the server.
'500':
description: Unexpected error.
/api/metadata/datatypes:
get:
tags:
- MetadataInfo
summary: Get all available defined field data types for each Act! record type.
operationId: MetadataInfo_GetAllowedDataTypes_C0BD5F64
parameters:
- name: recordType
in: query
required: false
description: Specifies the core mutable record types within the ACT! application (Company, Contact, Group, Opportunity, Product or any custom entity name).
schema:
type: string
responses:
'200':
description: OK indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.TypeCodes.EnumTypes'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.TypeCodes.EnumTypes'
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.TypeCodes.EnumTypes'
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'500':
description: Unexpected error.
/api/metadata/drop-down/lists:
get:
tags:
- MetadataInfo
summary: Get all drop-down list matching an (optional) OData query
operationId: MetadataInfo_GetDropDownLists_1C3E17D1
responses:
'200':
description: OK indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'500':
description: Unexpected error.
post:
tags:
- MetadataInfo
summary: Create a new drop-down list
operationId: MetadataInfo_PostDropDownList_15B36751
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.CreateDropDownList'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.CreateDropDownList'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.CreateDropDownList'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.CreateDropDownList'
responses:
'201':
description: Created indicates that the request resulted in a new resource created before the response was sent.
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownList'
'400':
description: BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code.
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'404':
description: NotFound indicates that the requested resource does not exist on the server.
'500':
description: Unexpected error.
/api/metadata/drop-down/lists/{list}/items/{item}:
get:
tags:
- MetadataInfo
summary: Gets a specific drop-down pick list item.
operationId: MetadataInfo_GetDropDownPickListItem_C1E8E2A4
parameters:
- name: list
in: path
required: true
description: The unique identifier (id) for a given PickList.
schema:
type: string
- name: item
in: path
required: true
description: The unique identifier (id) for a given item within a PickList.
schema:
type: string
responses:
'200':
description: OK indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownPickListItem'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownPickListItem'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownPickListItem'
'400':
description: BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code.
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'500':
description: Unexpected error.
/api/metadata/drop-down/lists/{list}/items:
get:
tags:
- MetadataInfo
summary: Gets all drop-down pick list item(s).
operationId: MetadataInfo_GetDropDownPickListItems_452A074F
parameters:
- name: list
in: path
required: true
description: The unique identifier (id) for a given PickList.
schema:
type: string
responses:
'200':
description: OK indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownPickListItem'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownPickListItem'
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.DropDownPickListItem'
'400':
description: BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code.
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'500':
description: Unexpected error.
/api/metadata/entities:
get:
tags:
- MetadataInfo
summary: Get all entity matching an (optional) OData query.
operationId: MetadataInfo_GetEntities_76EDEF77
responses:
'200':
description: OK indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'500':
description: Unexpected error.
post:
tags:
- MetadataInfo
summary: Create a new custom table (custom entity), optionally linked to parent entities.
operationId: MetadataInfo_PostTable_6ABDBD3A
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.NewCustomTable'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.NewCustomTable'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.NewCustomTable'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.NewCustomTable'
description: The custom table definition (technical name, display name, and optional parent entities).
responses:
'201':
description: Created indicates that the request resulted in a new resource created before the response was sent.
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Entity'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Entity'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Entity'
'400':
description: BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code.
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'409':
description: Conflict indicates that a custom entity with the requested name already exists.
'500':
description: Unexpected error.
/api/metadata/fields:
get:
tags:
- MetadataInfo
summary: Get all fields matching an (optional) OData query.
operationId: MetadataInfo_GetField_76332063
parameters:
- name: showAll
in: query
required: false
description: This defines if it only shows customizable (false) metadata or visible (true) metadata
schema:
type: boolean
responses:
'200':
description: OK indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'500':
description: Unexpected error.
/api/metadata/fields/{id}:
get:
tags:
- MetadataInfo
summary: Get a specific field
operationId: MetadataInfo_GetField_92E2951A
parameters:
- name: id
in: path
required: true
description: A unique identifier for a field.
schema:
type: string
responses:
'200':
description: OK indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'500':
description: Unexpected error.
/api/metadata/{recordType}/fields:
get:
tags:
- MetadataInfo
summary: Get all fields matching an (optional) OData query.
operationId: MetadataInfo_GetFields_387CA408
parameters:
- name: recordType
in: path
required: true
description: Specifies the core mutable record types within the ACT! application (Company, Contact, Group, Opportunity, Product or any custom entity name).
schema:
type: string
- name: showAll
in: query
required: false
description: This defines if it only shows customizable (false) metadata or visible (true) metadata
schema:
type: boolean
responses:
'200':
description: OK indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.Column'
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'500':
description: Unexpected error.
post:
tags:
- MetadataInfo
summary: Create a new field.
operationId: MetadataInfo_PostField_AD1FA9C5
parameters:
- name: recordType
in: path
required: true
description: Specifies the core mutable record types within the ACT! application (Company, Contact, Group, Opportunity, Product or any custom entity name).
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.NewColumn'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.NewColumn'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.NewColumn'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.NewColumn'
description: The field descriptor
responses:
'201':
description: Created indicates that the request resulted in a new resource created before the response was sent.
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.NewColumn'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.NewColumn'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Schema.NewColumn'
'400':
description: BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code.
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'404':
description: NotFound indicates that the requested resource does not exist on the server.
'500':
description: Unexpected error.
/api/metadata/{recordType}/picklists/{id}:
get:
tags:
- MetadataInfo
summary: Get specific pick list
operationId: MetadataInfo_GetPicklist_0EAAC225
parameters:
- name: id
in: path
required: true
description: A unique identifier for a field.
schema:
type: string
- name: recordType
in: path
required: true
description: Specifies the core mutable types within the ACT! application (Company, Contact, Group, Opportunity, Product or any custom entity name).
schema:
type: string
- name: showAll
in: query
required: false
description: This defines if it only shows customizable (false) metadata or visible (true) metadata
schema:
type: boolean
responses:
'200':
description: OK indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.PickList'
application/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.PickList'
text/xml:
schema:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.PickList'
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
'500':
description: Unexpected error.
/api/metadata/{recordType}/picklists:
get:
tags:
- MetadataInfo
summary: Get all pick list matching an (optional) OData query.
operationId: MetadataInfo_GetPicklists_8295BDC6
parameters:
- name: recordType
in: path
required: true
description: Specifies the core mutable types within the ACT! application (Company, Contact, Group, Opportunity, Product or any custom entity name).
schema:
type: string
- name: showAll
in: query
required: false
description: This defines if it only shows customizable (false) metadata or visible (true) metadata
schema:
type: boolean
responses:
'200':
description: OK indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.PickList'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.PickList'
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/act.web.api.models.MetaData.Picklists.PickList'
'401':
description: Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform t
# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/act/refs/heads/main/openapi/act-metadatainfo-api-openapi.yml