List the files attached to a record

GET

/api/v1/files

curl --request GET \
  --url 'https://api.pitch2sale.com/api/v1/files?entity_type=lead&entity_id=example&page=1&limit=50' \
  --header 'Authorization: Bearer <token>'

Requires entity_type and entity_id; paginated, optionally by category.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Query Parameters

entity_type

required

string

Allowed values: lead contact activity proposal contract invoice estimate project ticket user_avatar org_avatar

entity_id

required

string

/^[0-9a-fA-F]{24}$/

page

integer

default: 1 >= 1

limit

integer

default: 50 >= 1 <= 100

category

string

<= 64 characters

Responses

200

OK

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}