🖇️Pipelines
API Endpoints for Deals Pipelines
List Pipelines GET
Endpoint: https://subdomain.appcrm.com.br/api/pipelines
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 Pipeline GET
Endpoint: https://subdomain.appcrm.com.br/api/pipelines/{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 Pipeline POST
Endpoint: https://subdomain.appcrm.com.br/api/pipelines
Headers
Content-Type
Required
string
application/json
Accept
Required
string
application/json
Authorization
Required
string
Bearer {token}
Body Parameters
name
Required
string
stages
Optional
array
An array with stages Example:
[
["name" => "Stage Name", "win_probability" => 20, "display_order" => 1],
["name" => "Other Stage Name", "win_probability" => 40, "display_order" => 2],
]Update Pipeline PUT
Endpoint: https://subdomain.appcrm.com.br/api/pipelines/{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
stages
Optional
array
An array with stages Example:
[
["name" => "Stage Name", "win_probability" => 20, "display_order" => 1],
["name" => "Other Stage Name", "win_probability" => 40, "display_order" => 2],
]Delete Pipeline DELETE
Endpoint: https://subdomain.appcrm.com.br/api/pipelines/{id}
Headers
Content-Type
Required
string
application/json
Accept
Required
string
application/json
Authorization
Required
string
Bearer {token}
Path Parameters
id
integer
The ID of the record
Search Pipelines GET
Endpoint: https://subdomain.appcrm.com.br/api/pipelines/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
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
Retrieve Pipeline Stages GET
Endpoint: https://subdomain.appcrm.com.br/api/pipelines/{id}/stages
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
Last updated
Was this helpful?