AVavionte
Talent
Jobs

Get Pipeline Stage IDs

Returns a paged list of all pipeline stage IDs for the tenant.

get/v1/pipeline/ids/{page}/{pageSize}

Request

  • Base URL
    https://api.avionte.com/front-office
  • URL
    https://api.avionte.com/front-office/v1/pipeline/ids/{page}/{pageSize}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

pagestring required

The page number to retrieve in a paginated response.

pageSizestring required

The number of records to include per page in a paginated response.

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

A paged list of pipeline stage IDs.

pageinteger

The page number of the paginated response.

pageSizeinteger

The number of records included per page in the paginated response.

totalinteger

The total number of pipeline stage records available across all pages.

Example response

{
  "page": 1,
  "pageSize": 25,
  "total": 187,
  "data": [
    {
      "pipe_ID": 1848945,
      "pipe_Stage": "Pipelined"
    }
  ]
}

Changes

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