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:

• request resource and method,
• 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

Path and query parameters

This endpoint takes no additional path and/or query parameters.

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.

Example get organizations request body from Ortto’s CDP

json
 
{
  "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"
    }
  }
}

Example get organizations request body from Ortto’s CDP

json
 
{
  "q": "ortto"
}

Generating filters using the browser's dev tools

Depending on the number of conditions, fields, or activities in your filter, creating it reliably can become complex. Fortunately, we have a trick that lets you copy an already created filter from the browser's dev tools. You can follow these steps if you're using Google Chrome. If you're using a different browser, you may need to adjust the steps accordingly.

Follow the steps below to do this:

1. Open the browser's dev tools and select the Network tab.
2. Create the filter in-app on the Organization page.
3. Locate the create request and click on it.
4. In the Preview tab, right-click on the filter and select either Copy value or Copy object.
5. Paste the object into your API call.

Example filter retrieved from the network tab

json
 
{
    "$and": [
        {
            "$and": [
                {
                    "$str::contains": {
                        "label": "Website contains ortto.com",
                        "field_id": "str:o:website",
                        "timezone": "Italy",
                        "value": "ortto.com"
                    }
                },
                {
                    "$act::has_occurred": {
                        "formData": {
                            "mode": "hasOccurred",
                            "label": "Opened email has occurred",
                            "hasOccurred": {
                                "op": "$act::has_occurred",
                                "label": "has occurred"
                            }
                        },
                        "label": "Opened email has occurred",
                        "field_id": "act::o",
                        "timezone": "Italy",
                        "name": "Opened email",
                        "icon": "audience-newsletter-icon"
                    }
                }
            ]
        }
    ]
}

Retrieve organizations based on Organization ID

To retrieve Organization records based on their IDs, use the following endpoint

 
POST https://api.ap3api.com/v1/organizations/get-by-ids

Simply include the IDs of the Organizations you want to retrieve within the organization_ids parameter.

Example get organizations request body based on Organization ID

json
 
{  
  "organization_ids": ["10668b9d5c7d7d6dd895e100", "1066276f1272c7d821defc00"],  
  "fields": ["str:o:name"]
}

Valid request body elements

The following table lists all valid request body elements (arrays, objects, or fields), which are available to this endpoint.

json
 
{
  "type": "archived_organization"
}

json
 
{
"type": "organization",
"filter": {
  "$str::is": {
    "field_id": "str:o:name",
    "value": "Bobs Burgers"
}
}
}

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.

Example get organizations response payload from Ortto’s CDP

json
 
{
    "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.