Skip to content
Coritra Coritra Docs

List attribution schemas

GET
/api/v1/attribution-schemas
 
curl --request GET \
  --url 'https://example.com/api/v1/attribution-schemas?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 schema IDs

customer_ids
Array<string>

Filter by customer IDs

workspace_ids
Array<string>

Filter by workspace IDs

name
string

Filter by schema name (case-insensitive substring match)

page
integer
default: 1 >= 1

Page number for pagination (default: 1)

per_page
integer
default: 10 >= 1 <= 100

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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
attribution_schemas
required
Array<object>
object
id
required
string format: uuid
name
required
string
customer_id
required
string format: uuid
workspace_id
required
string format: uuid
properties
required
Array
One of: discriminator: type
object
name
required
string
type
required
string
Allowed values: string
required
required
boolean
default
string
nullable
total
required

Total number of attribution schemas matching the query

integer
page
required

Current page number

integer
per_page
required

Number of attribution schemas returned per page

integer
Example 
{
  "attribution_schemas": [
    {
      "properties": [
        {
          "type": "string"
        }
      ]
    }
  ]
}

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."
}