Opportunities

get/v1/opportunities

Request

  • Base URL: https://api.relaticle.com
  • URL: https://api.relaticle.com/v1/opportunities
  • Auth: HTTP bearer

Query parameters

filter[name][{operator}]string

Filter by name. Operators: $eq, $contains, $is_empty.

filter[created_at][{operator}]string

Filter by created_at. Operators: $eq, $gt, $gte, $lt, $lte, $is_empty.

filter[updated_at][{operator}]string

Filter by updated_at. Operators: $eq, $gt, $gte, $lt, $lte, $is_empty.

filter[creation_source][{operator}]string

Filter by creation_source. Operators: $eq, $in, $not_in, $is_empty.

filter[creator][{operator}]string

Filter by creator. Operators: $in, $not_in, $is_empty.

filter[company][{operator}]string

Filter by company. Operators: $in, $not_in, $is_empty.

filter[contact][{operator}]string

Filter by contact. Operators: $in, $not_in, $is_empty.

filter[stale_days][{operator}]string

Filter by stale_days. Operators: $gte.

filter[custom_fields][{code}][{operator}]string

Filter by a custom field value. Text: $eq, $contains. Number, currency, date, date-time: $eq, $gt, $gte, $lt, $lte. Email, phone, link, domain, checkbox-list, tags-input, multi-select: $has_any, $has_none. Checkbox, toggle: $eq. Radio, toggle-buttons, select: $eq, $in, $not_in. In a query string $is_empty also takes 1 or 0. Checkbox-list, radio, toggle-buttons, select and multi-select values take an option label or ID. An unknown one returns 422. Choice lists split on commas, so repeat the parameter with [] when a label contains a comma. Email values match in any letter case. Phone values match in any format, and the operand needs a country code such as +1 415 555 0100. Link values match in any letter case, with or without the scheme. Domain values match as a bare host or a full URL, with or without www. Tags-input values match the exact stored value. Date-time values match a date without a time, such as 2026-10-01, as that whole day. Email and link fields also take a domain sub-field with $in or $not_in, such as {"domain":{"$in":["acme.com"]}}, which matches the host of each value. $not_in and $has_none also match records where the field is empty. $is_empty takes true or false. Repeat [] to send several values. A filter holds at most 20 conditions, 3 levels of $and, $or and $not, and 2 levels of relations. A list holds at most 100 values. Examples: filter[custom_fields][stage][$in]=Qualification,Prospecting and filter[custom_fields][emails][domain][$not_in]=acme.com.

sortstring

Sort results. Prefix with - for descending. Allowed: name, -name, created_at, -created_at, updated_at, -updated_at.

Example:-created_at
includestring

Include related resources (comma-separated). Allowed: creator, company, contact, tasksCount, notesCount.

Example:creator
per_pageinteger

Number of results per page (1-100). Default: 15.

Example:15
cursorstring

Switches to cursor pagination. Send true for the first page, then the meta.next_cursor value of the previous page. Sorts by a custom field need page.

pageinteger

Page number for offset pagination (1-1,000,000, when cursor is not used). Default: 1.

Example:1

Request body

per_pageinteger

Must be at least 1. Must not be greater than 100.

cursorstring
pageinteger

Must be at least 1. Must not be greater than 1000000.

includestring
sortstring
fieldsstring

Example request

{
  "per_page": 16,
  "page": 7,
  "include": "ab",
  "sort": "ab"
}

Response

Example response

{
  "data": [
    {
      "id": "",
      "type": "opportunities",
      "attributes": {
        "name": "Eius nihil cumque quia sunt aut dolores.",
        "company_id": null,
        "contact_id": null,
        "creation_source": "web",
        "created_at": "2026-10-18T19:06:15.000000Z",
        "updated_at": "2026-10-18T19:06:15.000000Z",
        "custom_fields": {}
      }
    },
    {
      "id": "",
      "type": "opportunities",
      "attributes": {
        "name": "Delectus nemo molestiae ea quia ea.",
        "company_id": null,
        "contact_id": null,
        "creation_source": "web",
        "created_at": "2026-10-18T19:06:15.000000Z",
        "updated_at": "2026-10-18T19:06:15.000000Z",
        "custom_fields": {}
      }
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "page": null,
        "active": false
      },
      {
        "url": "/?page=1",
        "label": "1",
        "page": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "page": null,
        "active": false
      }
    ],
    "path": "/",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.