🖇️Companies
API Endpoints for Companies
List Companies GET
Endpoint: https://subdomain.appcrm.com.br/api/companies
Headers
Content-Type
Required
string
application/json
Accept
Required
string
application/json
Authorization
Required
string
Bearer {token}
Query Parameters
order
Optional
string
Sort the results being queried.
Example: ?order=created_at or ?order=created_at|desc
select
Optional
string
Select only the provided fields, useful for query optimization.
Example: ?select=first_name;id
per_page
Optional
integer
Provide the total number of records to query per page.
Example: ?per_page=20
page
Optional
integer
The page number to retrieve results for.
Example: ?page=2
q
Optional
string
Search records by a given query.
Example: ?q=John
search_fields
Optional
string
Change the fields that the search will be performed to
Example:?search_fields=email:like;phones.number:=
search_match
Optional
string
By default the search queries are performed using the OR comparison operator for each query parameter, if you need to match all parameters, you will need to use the AND comparison operator.
Example: ?search_match=and
Retrieve Company GET
Endpoint: https://subdomain.appcrm.com.br/api/companies/{id}
Headers
Content-Type
Required
string
application/json
Accept
Required
string
application/json
Authorization
Required
string
Bearer {token}
Path Parameters
id
Required
integer
The ID of the record
Create Company POST
Endpoint: https://subdomain.appcrm.com.br/api/companies
Headers
Content-Type
Required
string
application/json
Accept
Required
string
application/json
Authorization
Required
string
Bearer {token}
Body Parameters
name
Required
string
Optional
string
domain
Optional
string
phones
Optional
array
Example:
[
[ "number" => "+999-999-999", "type" => "mobile" ],
[ "number" => "+4020-4020", "type" => "work" ],
[ "number" => "+988-888-888", "type" => "other"'],
]user_id
Optional
integer
Owner of the company
tags
Optional
array
Tag names for the company
source_id
Optional
integer
ID of the source
industry_id
Optional
integer
ID of the industry
parent_company_id
Optional
integer
street
Optional
string
city
Optional
string
state
Optional
string
postal_code
Optional
string
country_id
Optional
integer
ID of the country
contacts
Optional
array
Array of contact ID's the company is associated with.
deals
Optional
array
Array of deal ID's the company is associated with.
customFields
Optional
mixed
Any additional custom fields
Update Company PUT
Endpoint: https://subdomain.appcrm.com.br/api/companies/{id}
Headers
Content-Type
Required
string
application/json
Accept
Required
string
application/json
Authorization
Required
string
Bearer {token}
Path Parameters
id
Required
integer
The ID of the record
Body Parameters
name
Required
string
Optional
string
domain
Optional
string
phones
Optional
array
Example:
[
[ "number" => "+999-999-999", "type" => "mobile" ],
[ "number" => "+4020-4020", "type" => "work" ],
[ "number" => "+988-888-888", "type" => "other"'],
]user_id
Optional
integer
Owner of the company
tags
Optional
array
Tag names for the company
source_id
Optional
integer
ID of the source
industry_id
Optional
integer
ID of the industry
parent_company_id
Optional
integer
street
Optional
string
city
Optional
string
state
Optional
string
postal_code
Optional
string
country_id
Optional
integer
ID of the country
contacts
Optional
array
Array of contact ID's the company is associated with.
deals
Optional
array
Array of deal ID's the company is associated with.
...customFields
Optional
mixed
Any additional custom fields
Delete Company DELETE
Endpoint: https://subdomain.appcrm.com.br/api/companies/{id}
Headers
Content-Type
Required
string
application/json
Accept
Required
string
application/json
Authorization
Required
string
Bearer {token}
Path Parameters
id
Required
integer
The ID of the record
Search Companies GET
Endpoint: https://subdomain.appcrm.com.br/api/companies/search?q={query}
Use this endpoint to perform search without pagination and use the take parameter if you need to limit the results.
Headers
Content-Type
Required
string
application/json
Accept
Required
string
application/json
Authorization
Required
string
Bearer {token}
Path Parameters
q
Required
string
Query Parameters
take
Optional
integer
The maximum number of results to query
Example: ?take=1
order
Optional
string
Sort the results being queried.
Example: ?order=created_at or ?order=created_at|desc
select
Optional
string
Select only the provided fields, useful for query optimization.
Example: ?select=first_name;id
search_fields
Optional
string
Change the fields that the search will be performed to
Example:?search_fields=email:like;phones.number:=
search_match
Optional
string
By default the search queries are performed using the OR comparison operator for each query parameter, if you need to match all parameters, you will need to use the AND comparison operator.
Example: ?search_match=and
Attach Associations to Company PUT
Endpoint: https://subdomain.appcrm.com.br/api/associations/companies/{id}
Hearders
Content-Type
Required
string
application/json
Accept
Required
string
application/json
Authorization
Required
string
Bearer {token}
Path Parameters
id
Required
integer
The ID of the record
Make sure to provide at least one resource.
Body Parameters
contacts
Optional
array
Array of contacts ID's to attach
deals
Optional
array
Array of deals ID's to attach
activities
Optional
array
Array of activities ID's to attach
Detach Associations From Company DELETE
Endpoint: https://subdomain.appcrm.com.br/api/associations/companies/{id}
Headers
Content-Type
Required
string
application/json
Accept
Required
string
application/json
Authorization
Required
string
Bearer {token}
Path Parameters
id
Required
integer
The ID of the record
Make sure to provide at least one resource.
Body Parameters
contacts
Optional
array
Array of contacts ID's to detach
deals
Optional
array
Array of deals ID's to detach
activities
Optional
array
Array of activities ID's to detach
Sync Associations To Company POST
Endpoint: https://subdomain.appcrm.com.br/api/associations/companies/{id}
Headers
Content-Type
Required
string
application/json
Accept
Required
string
application/json
Authorization
Required
string
Bearer {token}
Path Parameters
id
Required
integer
The ID of the record
Make sure to provide at least one resource.
Body Parameters
contacts
Optional
array
Array of contacts ID's to sync
deals
Optional
array
Array of deals ID's to sync
activities
Optional
array
Array of activities ID's to sync
Last updated
Was this helpful?