Retrieve Single Project

Request

Path Params

project_id

string <uuid>

required

Query Params

show

string

optional

limit the response to show only specific properties, see show & hide for more info

Example:

id,updated_at

hide

string

optional

hide properties from the response, see show & hide for more info

Example:

created_at,updated_at

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Ok

application/json

Body

id

string <uuid>

read-onlyoptional

Unique identifier

name

string

optional

<= 100 characters

description

string | null

optional

<= 150 characters

code

string | null

optional

<= 50 characters

transaction

string | null

optional

<= 36 characters

external_ref

string | null

read-onlyoptional

Third-party reference of the object, for informational purposes only

Example:

fb1033a2ed70

created_at

string <date-time>

read-onlyoptional

Date and time of creation

Example:

2024-04-11T10:22:15Z

updated_at

string <date-time>

read-onlyoptional

Date and time of last update

Example:

2024-04-11T10:22:15Z

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "code": "string",
    "transaction": "string",
    "external_ref": "fb1033a2ed70",
    "created_at": "2024-04-11T10:22:15Z",
    "updated_at": "2024-04-11T10:22:15Z"
}

🟠404Not Found

🟠401Not Logged In