Skip to content
Coritra Coritra Docs

List attributions

GET
/api/v1/attributions
 
curl --request GET \
  --url 'https://example.com/api/v1/attributions?page=1&per_page=10' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
ids
Array<string>

Filter by attribution IDs

partner_ids
Array<string>

Filter by partner IDs

workspace_ids
Array<string>

Filter by workspace IDs

page
integer
default: 1

Page number for pagination (default: 1)

per_page
integer
default: 10

Number of items per page for pagination (default: 10)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
attributions
required
Array<object>
object
id
required

Unique identifier of the attribution

string format: uuid
partner_id
required

ID of the partner associated with the attribution

string format: uuid
customer_id
required

ID of the customer associated with the attribution

string format: uuid
schema_id
required

ID of the attribution schema this attribution was validated against

string format: uuid
metadata
required
object
agent_id

Optional ID of the agent linked to this attribution

string format: uuid
nullable
events
required

Ordered list of events representing the lifecycle of this attribution

Array<object>
object
datetime
required

Timestamp when the event occurred

string format: date-time
event
required
One of: discriminator: type
object
type
required
string
Allowed values: create_attribution
properties
required

Custom key-value properties attached to the attribution at creation

object
key
additional properties
any
view
required
object
status
required

Current lifecycle status of the attribution

string
Allowed values: confirmed cancelled
cancel_reason

Reason for cancellation, present only when status is ‘cancelled’

string
nullable
properties
required

Custom properties attached to this attribution at creation time

object
key
additional properties
created_at

Timestamp when the attribution was created

string format: date-time
nullable
total
required

Total number of attributions matching the query

integer format: int64
page
required

Current page number

integer format: int64
per_page
required

Number of items per page

integer format: int64
Example 
{
  "attributions": [
    {
      "events": [
        {
          "event": {
            "type": "create_attribution"
          }
        }
      ],
      "view": {
        "status": "confirmed"
      }
    }
  ]
}

401

Section titled “401 ”

Unauthorized

Media type application/json
object
error_code
required
string
Allowed values: UNAUTHORIZED NOT_FOUND INTERNAL_ERROR BAD_REQUEST FORBIDDEN CONFLICT
message
required
string
Example 
{
  "error_code": "UNAUTHORIZED",
  "message": "Authentication credentials were not provided or are invalid."
}

500

Section titled “500 ”

Internal server error

Media type application/json
object
error_code
required
string
Allowed values: UNAUTHORIZED NOT_FOUND INTERNAL_ERROR BAD_REQUEST FORBIDDEN CONFLICT
message
required
string
Example 
{
  "error_code": "UNAUTHORIZED",
  "message": "Authentication credentials were not provided or are invalid."
}