Skip to main content
GET
/
projects
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": 123,
  "name": "<string>",
  "code": "<string>",
  "client": {
    "id": 123,
    "name": "<string>",
    "data": {},
    "addresses": [
      {
        "id": 123,
        "name": "<string>",
        "phone": "<string>",
        "post_code": "<string>",
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>"
      }
    ],
    "people": [
      {
        "id": 123,
        "name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "position": "<string>",
        "note": "<string>"
      }
    ],
    "category": {
      "id": 123,
      "type": "client"
    }
  },
  "billing_client": {
    "id": 123,
    "name": "<string>",
    "data": {},
    "addresses": [
      {
        "id": 123,
        "name": "<string>",
        "phone": "<string>",
        "post_code": "<string>",
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>"
      }
    ],
    "people": [
      {
        "id": 123,
        "name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "position": "<string>",
        "note": "<string>"
      }
    ],
    "category": {
      "id": 123,
      "type": "client"
    }
  },
  "address": {
    "id": 123,
    "address_line_1": "<string>",
    "address_line_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "postal_code": "<string>",
    "region_id": 123
  },
  "categories": [
    {
      "id": 123,
      "name": "<string>",
      "children": "<array>"
    }
  ],
  "project_currency": {
    "enabled": true,
    "currency": {
      "id": 123,
      "iso_code": "<string>",
      "name": "<string>"
    },
    "exchange_rates": [
      {
        "rate": 123,
        "exchange_currency": {
          "id": 123,
          "iso_code": "<string>",
          "name": "<string>"
        }
      }
    ]
  },
  "project_users": [
    {
      "user_id": 123,
      "access": "admin"
    }
  ]
}

Authorizations

authorization
string
header
required

Path Parameters

id
string
required

Response

OK

id
integer

The unique identifier for the project.

name
string

The name of the project.

code
string | null

The number of the project.

client
object
billing_client
object
address
object
categories
object[]

The categories of the project.

project_currency
object
project_users
object[]

The project users of the project.