Retrieve one or more organizations (get)
The get
Ortto endpoint of the organizations
entity is used to retrieve one or more organization records in Ortto’s customer data platform (CDP).
This page provides descriptions of this endpoint’s:
-
valid parameters, headers, and request body values, as well as
-
the response payload.
HTTP method and request resource
POST https://api.ap3api.com/v1/organizations/get
Ortto customers who have their instance region set to Australia or Europe will need to use specific service endpoints relative to the region:
For example: https://api.eu.ap3api.com/v1/<entity/endpoint> All other Ortto users will use the default service endpoint (https://api.ap3api.com/). |
Headers
This endpoint requires a custom API key and content type (application/json
for the request body) in the header of the request:
-
X-Api-Key: CUSTOM-PRIVATE-API-KEY
-
Content-Type: application/json
Request body
The request body consists of a JSON object whose valid elements are listed in the table below.
The following JSON objects are examples of field and object data that Ortto can recognize to get data from one or more organization records in your Ortto account’s CDP.
{
"limit": 100,
"sort_by_field_id": "str:o:name",
"sort_order": "asc",
"offset": 0,
"fields": ["int:o:employees", "str:o:industry"],
"filter": {
"$has_any_value": {
"field_id": "geo:o:country"
}
}
}
{
"q": "ortto"
}
Valid request body elements
The following table lists all valid request body elements (arrays, objects, or fields), which are available to this endpoint.
Element | Type | Description |
---|---|---|
|
|
The |
|
The |
|
|
The |
|
|
The |
|
|
|
A list of |
|
|
A list of |
|
The |
|
|
The |
|
|
|
The If you wish to search for organizations by ID, for example, you would need to use the |
|
The
If you are pairing To retrieve a list of archived organizations:
Or to use
|
|
|
The unique identifier for an organization in Ortto’s CDP.
This value is retrieved from the previous |
|
Object containing a organizations’s field ID (representing an organization field) used for filtering |
The |
Response payload
The response payload consists of a JSON object with the elements listed in the table below.
The following JSON object is an example of the tag data that Ortto retrieves from your Ortto account’s CDP after a request to this endpoint.
{
"organizations": [
{
"id": "10626f6df9a865ba45d95300",
"fields": {
"int:o:employees": 9000,
"str:o:industry": "Apparel"
}
},
{
"id": "10626f6df9a865ba45d95900",
"fields": {
"int:o:employees": 120,
"str:o:industry": "Consulting"
}
},
{
"id": "10626f6df9a865ba45d95600",
"fields": {
"int:o:employees": 2680,
"str:o:industry": "Construction"
}
},
{
"id": "10626f6df9a865ba45d96800"
}
],
"meta": {
"total_contacts": 25,
"total_organizations": 33,
"total_matches": 4,
"total_subscribers": 0
},
"offset": 0,
"next_offset": 4,
"cursor_id": "106332a05d1fde21791d9c9b",
"has_more": false
}
Response payload elements
The following table lists all elements (arrays, objects, or fields) in the response from a request to this endpoint.
Element | Description |
---|---|
|
An array of organizations with an id and a fields hash which contacts the list of fields you requested to be returned. |
|
A hash of meta data containing information about the matches to your contacts GET request, including:
|
|
The offset which was set on this request. |
|
The offset for fetching the next page of contacts. |
|
When retrieving the next page of contacts, provide this cursor_id. |
|
Whether or not there is a next page of contacts. |