List Projects

Successful Response

application/json

projects array of object

List of projects accessible by the user

example[{"id": "123456", "name": "Brand Health"}, {"id": "654321", "name": "Campaign Performance"}]

projects[].id string

ID of the project

example"123456"

projects[].name string

example"Brand Health"

200 example

{
    "projects": [
        {
            "id": "123456",
            "name": "Brand Health"
        },
        {
            "id": "654321",
            "name": "Campaign Performance"
        }
    ]
}

Bad request

application/json

errors array of object

Error that caused the request to fail; even though this is a list, it usually contains a single error

errors[].code string

Error code identifying the type of error

errors[].detail string

Message describing the problem

errors[].request_id string

Unique identifier for the request

errors[].meta object nullable

Additional metadata about the error

400 example

{
    "errors": [
        {
            "code": "string",
            "detail": "string",
            "request_id": "string",
            "meta": {}
        }
    ]
}

Unauthorized

application/json

errors array of object

Error that caused the request to fail; even though this is a list, it usually contains a single error

errors[].code string

Error code identifying the type of error

errors[].detail string

Message describing the problem

errors[].request_id string

Unique identifier for the request

errors[].meta object nullable

Additional metadata about the error

401 example

{
    "errors": [
        {
            "code": "string",
            "detail": "string",
            "request_id": "string",
            "meta": {}
        }
    ]
}

Forbidden

application/json

errors array of object

Error that caused the request to fail; even though this is a list, it usually contains a single error

errors[].code string

Error code identifying the type of error

errors[].detail string

Message describing the problem

errors[].request_id string

Unique identifier for the request

errors[].meta object nullable

Additional metadata about the error

403 example

{
    "errors": [
        {
            "code": "string",
            "detail": "string",
            "request_id": "string",
            "meta": {}
        }
    ]
}

Not found

application/json

errors array of object

Error that caused the request to fail; even though this is a list, it usually contains a single error

errors[].code string

Error code identifying the type of error

errors[].detail string

Message describing the problem

errors[].request_id string

Unique identifier for the request

errors[].meta object nullable

Additional metadata about the error

404 example

{
    "errors": [
        {
            "code": "string",
            "detail": "string",
            "request_id": "string",
            "meta": {}
        }
    ]
}

Method not allowed

application/json

errors array of object

Error that caused the request to fail; even though this is a list, it usually contains a single error

errors[].code string

Error code identifying the type of error

errors[].detail string

Message describing the problem

errors[].request_id string

Unique identifier for the request

errors[].meta object nullable

Additional metadata about the error

405 example

{
    "errors": [
        {
            "code": "string",
            "detail": "string",
            "request_id": "string",
            "meta": {}
        }
    ]
}

Internal server error

application/json

errors array of object

Error that caused the request to fail; even though this is a list, it usually contains a single error

errors[].code string

Error code identifying the type of error

errors[].detail string

Message describing the problem

errors[].request_id string

Unique identifier for the request

errors[].meta object nullable

Additional metadata about the error

500 example

{
    "errors": [
        {
            "code": "string",
            "detail": "string",
            "request_id": "string",
            "meta": {}
        }
    ]
}

Responses#