GET
/
v2
/
project
curl --request GET \
  --url https://api.sonderplan.com/v2/project \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 2342354,
      "name": "Andor S1 EP7 Annoucement",
      "code": "AND-S1-EP7",
      "description": "Colonel Yularen announces that the ISB has gained more surveillance and punitive authority, while Meero is challenged by Blevin for breaking protocol by accessing Imperial data without authorization.",
      "status": [
        {
          "id": 2,
          "name": "Second Hold",
          "description": "Has second priority if the first hold cancels",
          "notification": true
        }
      ],
      "private": 0,
      "parent_folder_id": 5,
      "color_background": "#B0A7F1",
      "color_text": "#000000",
      "start": 1547501100,
      "end": 1547538900,
      "client": [
        {
          "id": 4,
          "uuid": "p4",
          "name": "Jane Someone",
          "type": "person",
          "email": "[email protected]",
          "contact_person": {
            "id": 2837,
            "name": "Fred Flintstone"
          }
        }
      ],
      "custom_fields": [
        {
          "id": 7823,
          "name": "Type",
          "value": "Video Editing",
          "value_id": 8973,
          "update_key": "2_1_7823"
        }
      ],
      "people": {
        "users": [
          {
            "id": 4,
            "name": "Jane Smith",
            "admin_flag": 0,
            "role_id": 0,
            "role_name": 0,
            "project_admin": true,
            "group_write_admin": false
          }
        ]
      },
      "time_entries": [
        {
          "id": 9879871,
          "owner_id": 872383,
          "name": "Colour Grading",
          "description": "Opening scenes completed",
          "start": 1547501100,
          "end": 1547538900,
          "booking_id": 872383
        }
      ],
      "created_id": 3,
      "created": 1388552400,
      "created_name": "John Smith",
      "updated_id": 3,
      "updated": 1388552400,
      "updated_name": "John Smith"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string

One or more (comma seperated) IDs of projects to retrieve

​
name
string

Perform a partial match text search for the project name

​
code
string

Perform a partial match text search for the project code

​
description
string

Perform a partial match text search for the project description

​
status_id
integer

Perform an exact match for the project status_id

​
private
boolean

Perform an exact match for the project private boolean

​
parent_folder_id
integer

Perform an exact match for the project parent_folder_id

​
color_background
string

Perform a partial match text search for the projects background color

​
color_text
string

Perform a partial match text search for the projects text color

​
active_from
string

Filter projects that have a end greater than this value

​
active_to
string

Filter projects that have a start lesser than this value

​
updated_from
string

Filter projects where updated is greater than this value

​
updated_to
string

Filter projects where updated is lesser than this value

​
updated_after
integer

Return results that were added, edited or deleted since this UNIX timestamp

​
fields
string

Comma seperated list of fields you wish to return

​
page
integer

Specify the page of results you wish to return

​
limit
integer

The number of results returned per page. Default if not specified is 10

​
order_asc
string

Specify the field (with type of string or integer) you wish to order (ascending) the response with

​
order_desc
string

Specify the field (with type of string or integer) you wish to order (descending) the response with

​
filter_operator
enum<string>
default:OR

Specify if multiple filters should be combined with OR or AND logic

Available options:
OR,
AND

Response

200
application/json

Successful Operation

The response is of type object.