logo
API docs by Redocly

QuotaPath API (v1)

Documentation for the QuotaPath API

data

data_bulk-import_create

Authorizations:
token_auth
Request Body schema: application/json
data_id_field
required
string (Data id field) non-empty

data key to use for each element, such as 'id'

data_source
required
string (Data source) non-empty

source of data, such as 'salesforce'

data_type
required
string (Data type) non-empty

type of data for this source, such as 'opportunity'

data
required
string (Data)

list of json blobs or single item to represent data for import. Must include field specified by 'data_id_field'

Responses

Request samples

Content type
application/json
{
  • "data_id_field": "string",
  • "data_source": "string",
  • "data_type": "string",
  • "data": "string"
}

Response samples

Content type
application/json
{
  • "data_id_field": "string",
  • "data_source": "string",
  • "data_type": "string",
  • "data": "string"
}

deal

deal_list

List filtered deals or create deal with payload. No query params will list all deals. Supported query params are 'id', 'integration_id', 'path_id', and 'user_email'.

Authorizations:
token_auth
query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

deal_create

List filtered deals or create deal with payload. No query params will list all deals. Supported query params are 'id', 'integration_id', 'path_id', and 'user_email'.

Authorizations:
token_auth
Request Body schema: application/json
admin_locked
boolean (Admin locked)
date
string <date> (Date)
required
Array of objects (ExternalDealValue) non-empty
integration_id
string or null (Integration id) non-empty

Unique foreign key from data-integration, paired with source

name
required
string (Name) [ 1 .. 255 ] characters
state
string (State)
Enum: "closed" "open" "lost"
user_email
required
string <email> (User email) non-empty

deal owner email

object or null (ExternalDealMetadata)

Responses

Request samples

Content type
application/json
{
  • "admin_locked": true,
  • "date": "2019-08-24",
  • "deal_values": [
    ],
  • "integration_id": "string",
  • "name": "string",
  • "state": "closed",
  • "user_email": "user@example.com",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "admin_locked": true,
  • "created_date": "2019-08-24T14:15:22Z",
  • "date": "2019-08-24",
  • "deal_values": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "integration_id": "string",
  • "integration_source": "api",
  • "name": "string",
  • "state": "closed",
  • "updated_date": "2019-08-24T14:15:22Z",
  • "user_email": "user@example.com",
  • "metadata": {
    }
}

deal_bulk_create

Bulk update or create deals.

Authorizations:
token_auth
Request Body schema: application/json
required
Array of objects (ExternalBulkDeal)

Responses

Request samples

Content type
application/json
{
  • "deals": [
    ]
}

Response samples

Content type
application/json
[
  • { }
]

deal

View for retrieve, update, delete based on deal uuid

Authorizations:
token_auth
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "admin_locked": true,
  • "created_date": "2019-08-24T14:15:22Z",
  • "date": "2019-08-24",
  • "deal_values": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "integration_id": "string",
  • "integration_source": "api",
  • "name": "string",
  • "state": "closed",
  • "updated_date": "2019-08-24T14:15:22Z",
  • "user_email": "user@example.com",
  • "metadata": {
    }
}

deal_update

View for retrieve, update, delete based on deal uuid

Authorizations:
token_auth
path Parameters
uuid
required
string
Request Body schema: application/json
admin_locked
boolean (Admin locked)
date
string <date> (Date)
required
Array of objects (ExternalDealValue) non-empty
integration_id
string or null (Integration id) non-empty

Unique foreign key from data-integration, paired with source

name
required
string (Name) [ 1 .. 255 ] characters
state
string (State)
Enum: "closed" "open" "lost"
user_email
required
string <email> (User email) non-empty

deal owner email

object or null (ExternalDealMetadata)

Responses

Request samples

Content type
application/json
{
  • "admin_locked": true,
  • "date": "2019-08-24",
  • "deal_values": [
    ],
  • "integration_id": "string",
  • "name": "string",
  • "state": "closed",
  • "user_email": "user@example.com",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "admin_locked": true,
  • "created_date": "2019-08-24T14:15:22Z",
  • "date": "2019-08-24",
  • "deal_values": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "integration_id": "string",
  • "integration_source": "api",
  • "name": "string",
  • "state": "closed",
  • "updated_date": "2019-08-24T14:15:22Z",
  • "user_email": "user@example.com",
  • "metadata": {
    }
}

deal_partial_update

View for retrieve, update, delete based on deal uuid

Authorizations:
token_auth
path Parameters
uuid
required
string
Request Body schema: application/json
admin_locked
boolean (Admin locked)
date
string <date> (Date)
required
Array of objects (ExternalDealValue) non-empty
integration_id
string or null (Integration id) non-empty

Unique foreign key from data-integration, paired with source

name
required
string (Name) [ 1 .. 255 ] characters
state
string (State)
Enum: "closed" "open" "lost"
user_email
required
string <email> (User email) non-empty

deal owner email

object or null (ExternalDealMetadata)

Responses

Request samples

Content type
application/json
{
  • "admin_locked": true,
  • "date": "2019-08-24",
  • "deal_values": [
    ],
  • "integration_id": "string",
  • "name": "string",
  • "state": "closed",
  • "user_email": "user@example.com",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "admin_locked": true,
  • "created_date": "2019-08-24T14:15:22Z",
  • "date": "2019-08-24",
  • "deal_values": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "integration_id": "string",
  • "integration_source": "api",
  • "name": "string",
  • "state": "closed",
  • "updated_date": "2019-08-24T14:15:22Z",
  • "user_email": "user@example.com",
  • "metadata": {
    }
}

deal_delete

View for retrieve, update, delete based on deal uuid

Authorizations:
token_auth
path Parameters
uuid
required
string

Responses

path

path_quota_assignments_list

Authorizations:
token_auth
path Parameters
path_uuid
required
string
query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

path_quota_assignments_create

Authorizations:
token_auth
path Parameters
path_uuid
required
string

Responses

path_quota_values_list

Authorizations:
token_auth
path Parameters
path_uuid
required
string
query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

path_quota_values_create

Authorizations:
token_auth
path Parameters
path_uuid
required
string

Responses

payout

payout_list

Authorizations:
token_auth
query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

updated_since
integer

Unix timestamp in seconds. Specify to only return records updated after this timestamp.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

payout_resolved_list

Authorizations:
token_auth
query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

updated_since
integer

Unix timestamp in seconds. Specify to only return records updated after this timestamp.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

payout_unresolved_list

Authorizations:
token_auth
query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

plan

plan_list

Authorizations:
token_auth
query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

team

team_list

This view gets the workspace's team IDs + names along with lists of the current member & manager emails

Authorizations:
token_auth
query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{}

user

user_list

Authorizations:
token_auth
query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{}