List projects - Fohlio API

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

GET

projects

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

Query Parameters

page

integer

default:1

Page #

per_page

integer

default:25

Page Size

Required range: 1 <= x <= 100

updated_since

integer

Unix Time

Response

integer

The unique identifier for the project.

name

string

The name of the project.

code

string | null

The number of the project.

client

object

Show child attributes

client.id

integer

client.name

string

client.data

object

The details of the contact encoded in JSON format.

client.addresses

object[]

Show child attributes

client.addresses.id

integer

client.addresses.name

string

client.addresses.phone

string | null

client.addresses.post_code

string | null

client.addresses.address_line_1

string | null

client.addresses.address_line_2

string | null

client.addresses.city

string | null

client.addresses.state

string | null

client.addresses.country

string | null

client.people

object[]

Show child attributes

client.people.id

integer

client.people.name

string | null

client.people.email

string | null

client.people.phone

string | null

client.people.position

string | null

client.people.note

string | null

client.category

object

Show child attributes

client.category.id

integer

client.category.type

enum<string>

Available options:

client,

supplier,

general_contractor,

manufacture,

warehouse

billing_client

object

Show child attributes

billing_client.id

integer

billing_client.name

string

billing_client.data

object

The details of the contact encoded in JSON format.

billing_client.addresses

object[]

Show child attributes

billing_client.addresses.id

integer

billing_client.addresses.name

string

billing_client.addresses.phone

string | null

billing_client.addresses.post_code

string | null

billing_client.addresses.address_line_1

string | null

billing_client.addresses.address_line_2

string | null

billing_client.addresses.city

string | null

billing_client.addresses.state

string | null

billing_client.addresses.country

string | null

billing_client.people

object[]

Show child attributes

billing_client.people.id

integer

billing_client.people.name

string | null

billing_client.people.email

string | null

billing_client.people.phone

string | null

billing_client.people.position

string | null

billing_client.people.note

string | null

billing_client.category

object

Show child attributes

billing_client.category.id

integer

billing_client.category.type

enum<string>

Available options:

client,

supplier,

general_contractor,

manufacture,

warehouse

address

object

Show child attributes

address.id

integer

address.address_line_1

string | null

address.address_line_2

string | null

address.city

string | null

address.state

string | null

address.country

string | null

address.postal_code

string | null

address.region_id

integer | null

API Reference

Authorizations

Query Parameters

Response