List Partners

GET /partners
Copied
Arrow
                https://api.ocamba.com/v1/hood/partners

Returns a list of Partners

query Parameters
Arrow
Name
Description
fieldsstring
Fields parameter represents array of dimensions and measures. Dimensions are used to categorize, segment, and reveal the details of the data. Measures contain numeric, quantitative values that can be measured. At least one measure is required.


Example: fields=field1,field2,field3
viewstring
Hood API returns full representation of the resource using the "view=full" query parameter. If not specified, the default view will be used.

Note that the "fields" parameter has precedence over the "view" parameter.


Example: view=full/default
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/hood/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/hood/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/hood/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,field2
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=lname → API retuns a certain resource whose lname contains string 'sou'.
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=fname,lname,email → API returns a certain resource that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.
qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /VERSION/hood/RESOURCE_NAME?q=sou → returns a certain resource that contain string 'sou'

See tips for the list of searchable parameters.
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ partner ]
An array of all items.
Partner
Name
Description
archivednumber
Describes if the partner is archived or not. Can only be adjusted through the dedicated endpoint.

Possible values: 0 | 1
billing_addressbilling-address
The billing address of the partner.
Billing Address
Name
Description
citystring
City.


Example: Toronto
countrystring
Accepts only valid 2 letter country codes.


Example: ca
postal_codestring
Postal code.


Example: M4C 1A1
streetstring
Street.


Example: 108 Hanson St
company_idstring
A unique identifier generated by the Ocamba.


Example: 2136950
contactcontact
The contact of the partner.
Contact
Name
Description
emailstring
The email of the partner.


Example: [email protected]
mobilestring
The mobile phone of the partner.


Example: +15551234567
phonestring
The landline of the partner.


Example: +441632960961
sipstring
The SIP of the partner.


Example: [email protected]
skypestring
The skype contact of the partner.


Example: john.doe123
websitestring
The website of the partner.


Example: https://www.example.com
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:00
descriptionstring
The description of the partner.


Example: Example description.
idstring
A unique identifier generated by the Ocamba.


Example: 1000018
manager_idsarray
Array of hood member id's created on the Ocamba platform.


Example: 11153151,6643410,3183560
managers[ managers ]
The array of managers of the partner defined by the menager_ids inserted.
Manager
Name
Description
emailstring
The email of the manager.


Example: [email protected]
idstring
The ID of the Manager, generated by Ocamba.


Example: 1000223
imagestring
The profile picture of the manager.


Example: https://sm.ocmcore.com/share/1231233/adex/media/profile-pic-36703721.jpg
namestring
The name of the manager.


Example: Alex Claire
statusstring
The status of the manager.


Example: active
namestring
The name of the partner


Example: Example Partner Name
payment_termspayment-terms
The payment terms to which the partner agreed.
Payment Terms
Name
Description
currency_codestring
Currency code.


Example: usd

Possible values: usd | eur
net_termsstring
Net Terms.


Example: net30

Possible values: net30 | net45 | net60 | net90
payment_frequencystring
The frequency of payment.


Example: annually

Possible values: monthly | quarterly | annually
payment_methodstring
Payment method.


Example: card

Possible values: bank-transfer | card | paypal
statusstring
Describes the status of the partner.


Example: active

Possible values: active | inactive | pending | suspended | terminated
systemnumber
Describes if the partner is system partner or not.


Example: 1

Possible values: 0 | 1
typearray
Describes the role of the partner.


Example: advertiser

Possible values: advertiser | publisher
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
totalinteger
A total number of items.


Example: 32
tip
1 Sortable fields are: name, create_time and update_time.
2 Searchable field is: name.
3 Filterable fields are: id, managers, type, status, payment_frequency, payment_method, net_terms, currency, archived, create_time and update_time.
4 If you want to find all your archived partners, you shoul use the filter 'archived'.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 3,
  "items": [
    {
      "id": "1000418",
      "company_id": "6197120",
      "manager_ids": [
          "1000188"
      ],
      "managers": [
          {
              "id": "1000188",
              "name": "Noah Turner",
              "email": "[email protected]",
              "status": "active"
          }
      ],
      "name": "Test Partner",
      "type": [
          "advertiser",
          "publisher"
      ],
      "status": "inactive",
      "system": 0,
      "create_time": "2024-09-24 13:28:19",
      "update_time": "2024-09-24 13:29:21"
    },
    {
      "id": "1000417",
      "company_id": "6197120",
      "manager_ids": [
        "1000189",
        "1000220"
      ],
      "managers": [
        {
          "id": "1000189",
          "name": "John Doe",
          "email": "[email protected]",
          "status": "active",
          "image": "https://sm.ocmcore.com/share/6197120/adex/media/1120152205rain-forest-36703721.jpg"
        },
        {
          "id": "1000220",
          "name": "Alex Claire",
          "email": "[email protected]",
          "status": "active"
        }
      ],
      "name": "Partner Example",
      "type": [
        "publisher"
      ],
      "status": "active",
      "system": 0,
      "create_time": "2024-09-24 11:26:04",
      "update_time": "2024-09-24 11:26:04"
    },
    {
      "id": "1000416",
      "company_id": "6197120",
      "manager_ids": [
        "1000189",
        "1000220"
      ],
      "managers": [
        {
          "id": "1000189",
          "name": "John Doe",
          "email": "[email protected]",
          "status": "active",
          "image": "https://sm.ocmcore.com/share/6197120/adex/media/1120152205rain-forest-36703721.jpg"
        },
        {
          "id": "1000220",
          "name": "Alex Claire",
          "email": "[email protected]",
          "status": "active"
        }
      ],
      "name": "Another Partners Example",
      "type": [
        "advertiser"
      ],
      "status": "active",
      "system": 0,
      "create_time": "2024-09-24 11:25:19",
      "update_time": "2024-09-24 11:25:19"
    }
  ]
}

{
  "total": 32,
  "items": [
    {
      "id": "1000018",
      "company_id": "2136950",
      "manager_ids": "11153151,6643410,3183560",
      "managers": [
        {
          "id": "1000223",
          "name": "Alex Claire",
          "status": "active",
          "email": "[email protected]",
          "image": "https://sm.ocmcore.com/share/1231233/adex/media/profile-pic-36703721.jpg"
        }
      ],
      "name": "Example Partner Name",
      "description": "Example description.",
      "type": "advertiser",
      "status": "active",
      "payment_terms": {
        "payment_frequency": "annually",
        "payment_method": "card",
        "net_terms": "net30",
        "currency_code": "usd"
      },
      "billing_address": {
        "street": "108 Hanson St",
        "city": "Toronto",
        "postal_code": "M4C 1A1",
        "country": "ca"
      },
      "contact": {
        "email": "[email protected]",
        "mobile": "+15551234567",
        "phone": "+441632960961",
        "sip": "[email protected]",
        "skype": "john.doe123",
        "website": "https://www.example.com"
      },
      "system": 1,
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}