Skip to main content
GET
Get upstream by ID or slug

Authorizations

Authorization
string
header
required

OAuth2 Authorization Code flow

Path Parameters

idOrSlug
string
required

Upstream ID or slug

Response

200 - application/json
object
string
required

Object type

Example:

"page"

id
string
required

Unique identifier

Example:

"p_abc123"

createdAt
string<date-time>
required

Creation timestamp

Example:

"2024-01-15T10:30:00.000Z"

updatedAt
string<date-time>
required

Last update timestamp

Example:

"2024-01-15T14:45:00.000Z"

name
string
required

Upstream name

Example:

"Federal Revenue"

description
string | null
required

Upstream description

logo
string | null
required

Upstream logo URL

slug
string
required

URL-friendly slug

Example:

"federal-revenue"

country
string
required

Country code

Example:

"BR"

type
string | null
required

Upstream type

url
string | null
required

Upstream URL

createdBy
Created by · object

Principal who created this object

Example:
updatedBy
Updated by · object

Principal who last updated this object

Example:

Whether this is the featured upstream

Example:

true