V1 Endpoints

We expect this endpoint to always return a successful response under nominal conditions.

Use this to assess whether subsequent calls to other endpoints will likely succeed. For example, it would be handy to make a request to this endpoint during the initialisation of a wrapper to verify that a valid authentication token has been provided and that there aren't any temporary internal server or database errors.

Token Type
Private & Shared

Method/URL
GET https://api.builtbybit.com/v1/health

Response Data
A string with content "ok".
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/alerts

Sortable Fields
"caused_member_id"
"content_type"
"content_id"
"alert_type"
"alert_date" (default)

Response Data
An array of Alert objects.
​

Token Type
Private

Method/URL
PATCH https://api.builtbybit.com/v1/alerts

Body Parameters
"read" - expects a boolean (should always be true)
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/conversations

Sortable Fields
"creation_date"
"creator_id"
"title"
"reply_count"
"last_message_date" (default)
"last_read_date"

Response Data
An array of Conversation objects.
​

Token Type
Private

Method/URL
POST https://api.builtbybit.com/v1/conversations

Body Parameters
"recipient_ids" - expects an array of member identifiers (non-negative integers)
"title" - expects a string
"message" - expects a string

Response Data
An unsigned integer representing the newly created conversation's identifier.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/conversations/{id}/replies

Path Parameters
"id" - expects a conversation identifier (non-negative integer)

Sortable Fields
"author_id"
"message_date" (default)
"message"

Response Data
An array of Reply objects.
​

Token Type
Private

Method/URL
POST https://api.builtbybit.com/v1/conversations/{id}/replies

Path Parameters
"id" - expects a conversation identifier (non-negative integer)

Body Parameters
"message" - expects a string

Response Data
An unsigned integer representing the newly created reply's identifier.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/members/self

Response Data
A Member object.
​

Token Type
Private

Method/URL
PATCH https://api.builtbybit.com/v1/members/self

Body Parameters
"custom_title" - expects a string, but is optional
"about_me" - expects a string, but is optional
"signature" - expects a string, but is optional
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/members/{id}

Path Parameters
"id" - expects a non-negative integer

Response Data
A Member object.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/members/usernames/{name}

Path Parameters
"name" - expects a string

Response Data
A Member object.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/members/discords/{discord_id}

Path Parameters
"discord_id" - expects a non-negative integer

Response Data
A Member object.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/members/bans

Response Data
An array of Ban objects.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/members/self/profile-posts

Sortable Fields
"author_id"
"post_date" (default)
"message"
"comment_count"

Response Data
An array of ProfilePost objects.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/members/self/profile-posts/{id}

Path Parameters
"id" - expects a non-negative integer

Response Data
A ProfilePost object.
​

Token Type
Private

Method/URL
PATCH https://api.builtbybit.com/v1/members/self/profile-posts/{id}

Path Parameters
"id" - expects a non-negative integer

Body Parameters
"message" - expects a string
​

Token Type
Private

Method/URL
DELETE https://api.builtbybit.com/v1/members/self/profile-posts/{id}

Path Parameters
"id" - expects a non-negative integer
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources

Sortable Fields
"last_update_date" (default)
"submission_date"
"title"
"downloads"
"rating"
"purchase_count"
"price"

Response Data
An array of BasicResource objects.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/owned

Sortable Fields
"last_update_date" (default)
"submission_date"
"title"
"downloads"
"rating"
"purchase_count"
"price"

Response Data
An array of BasicResource objects.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/collaborated

Sortable Fields
"last_update_date" (default)
"submission_date"
"title"
"downloads"
"rating"
"purchase_count"
"price"

Response Data
An array of BasicResource objects.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/authors/{id}

Path Parameters
"id" - a string representing the resource author's identifier

Sortable Fields
"last_update_date" (default)
"submission_date"
"title"
"downloads"
"rating"
"purchase_count"
"price"

Response Data
An array of BasicResource objects.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/{id}

Path Parameters
"id" - a string representing the resource's identifier

Response Data
A Resource object.
​

Token Type
Private

Method/URL
PATCH https://api.builtbybit.com/v1/resources/{id}

Path Parameters
"id" - a string representing the resource's identifier

Body Parameters
"title" - expects a string
"tag_line" - expects a string
"description" - expects a string
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/{id}/versions

Path Parameters
"id" - a non-negative integer representing the resource's identifier

Sortable Fields
"release_date" (default)
"name"
"download_count"

Response Data
An array of Version objects.
​

Token Type
Private & Shared

Method/URL
GET https://api.builtbybit.com/v1/resources/{id}/versions/latest

Path Parameters
"id" - a non-negative integer representing the resource's identifier

Response Data
A Version object.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/{r_id}/versions/{v_id}

Path Parameters
"r_id" - a non-negative integer representing the resource's identifier
"v_id" - a non-negative integer representing the version's identifier

Response Data
A Version object.
​

Token Type
Private

Method/URL
DELETE https://api.builtbybit.com/v1/resources/{r_id}/versions/{v_id}

Path Parameters
"r_id" - a non-negative integer representing the resource's identifier
"v_id" - a non-negative integer representing the version's identifier
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/{id}/updates

Path Parameters
"id" - a non-negative integer representing the resource's identifier

Sortable Fields
"update_date" (default)
"title"
"message"

Response Data
An array of Update objects.
​

Token Type
Private & Shared

Method/URL
GET https://api.builtbybit.com/v1/resources/{id}/updates/latest

Path Parameters
"id" - a non-negative integer representing the resource's identifier

Response Data
An Update object.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/{r_id}/updates/{u_id}

Path Parameters
"r_id" - a non-negative integer representing the resource's identifier
"u_id" - a non-negative integer representing the update's identifier

Response Data
An Update object.
​

Token Type
Private

Method/URL
DELETE https://api.builtbybit.com/v1/resources/{r_id}/updates/{u_id}

Path Parameters
"r_id" - a non-negative integer representing the resource's identifier
"u_id" - a non-negative integer representing the update's identifier
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/{id}/reviews

Path Parameters
"id" - expects a non-negative integer representing the resource's identifier

Sortable Fields
"review_date" (default)
"reviewer_id"
"rating"
"message"
"response"

Response Data
An array of Review objects.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/{r_id}/reviews/members/{m_id}

Path Parameters
"r_id" - expects a non-negative integer representing the resource's identifier
"m_id" - expects a non-negative integer representing the review's identifier

Response Data
A Review object.
​

Token Type
Private

Method/URL
PATCH https://api.builtbybit.com/v1/resources/{res_id}/reviews/{rev_id}

Path Parameters
"res_id" - expects a non-negative integer representing the resource's identifier
"rev_id" - expects a non-negative integer representing the review's identifier

Body Parameters
"response" - expects a string
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/{id}/purchases

Path Parameters
"id" - expects a non-negative integer representing the resource's identifier

Sortable Fields
"purchase_date" (default)
"validation_date"
"purchase_id"
"purchaser_id"
"license_id"
"renewal"
"status"
"price"
"currency"

Response Data
An array of Purchase objects.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/{r_id}/purchases/{p_id}

Path Parameters
"r_id" - expects a non-negative integer representing the resource's identifier
"p_id" - expects a non-negative integer representing the purchase's identifier

Response Data
A Purchase object.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/{id}/licenses

Path Parameters
"id" - expects a non-negative integer representing the resource's identifier

Sortable Fields
"start_end" (default)
"end_date"
"previous_end_date"
"license_id"
"purchaser_id"
"validated"
"active"

Response Data
An array of License objects.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/{r_id}/licenses/{l_id}

Path Parameters
"r_id" - a non-negative integer representing the resource's identifier
"l_id" - a non-negative integer representing the license's identifier

Response Data
A License object.
​

When modifying a license to be permanent, only the 'active' optional body parameter should be set.
When modifying a license to be temporary, only the 'start_date' and 'end_date' optional body parameters should be set.

Token Type
Private

Method/URL
PATCH https://api.builtbybit.com/v1/resources/{r_id}/licenses/{l_id}

Path Parameters
"r_id" - a non-negative integer representing the resource's identifier
"l_id" - a non-negative integer representing the license's identifier

Body Parameters
"permanent" - expects a boolean
"active" - optional, expects a boolean
"start_date" - optional, expects a UNIX timestamp
"end_date" - optional, expects a UNIX timestamp
​

We expect this endpoint to be used in conjunction with our anti-piracy placeholders to ensure that requests attempting to validate a license for a specific purchaser only succeed when we can be confident the request originated from that specific purchaser, and not another member of our platform.

Thus, when making a request to this endpoint via a Shared token type, we require that the "nonce" and "timestamp" anti-piracy placeholders be included as query parameters. These query parameters are ignored when making a request to this endpoint via a Private token type.

Token Type
Private & Shared

Method/URL
GET https://api.builtbybit.com/v1/resources/{r_id}/licenses/members/{m_id}

Path Parameters
"r_id" - a non-negative integer representing the resource's identifier
"m_id" - a non-negative integer representing the member's identifier

Query Parameters
"nonce" - expects a non-negative integer
"date" - expects a UNIX timestamp

Response Data
A License object.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/{id}/downloads

Path Parameters
"id" - expects a non-negative integer

Sortable Fields
"download_date" (default)
"version_id"
"downloader_id"

Response Data
An array of Download objects.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/{r_id}/downloads/members/{m_id}

Path Parameters
"r_id" - expects a non-negative integer representing the resource's identifier
"m_id" - expects a non-negative integer representing the member's identifier

Sortable Fields
"download_date" (default)
"version_id"

Response Data
An array of Download objects.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/resources/{r_id}/downloads/versions/{v_id}

Path Parameters
"r_id" - expects a non-negative integer representing the resource's identifier
"v_id" - expects a non-negative integer representing the version's identifier

Sortable Fields
"download_date" (default)
"downloader_id"

Response Data
An array of Download objects.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/threads

Sortable Fields
"title"
"reply_count"
"view_count"
"creation_date" (default)
"last_message_date"
"thread_open"

Response Data
An array of BasicThread objects.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/threads/{id}

Path Paramteres
"id" - expects a non-negative integer representing the thread's identifier

Response Data
A Thread object.
​

Token Type
Private

Method/URL
GET https://api.builtbybit.com/v1/threads/{id}/replies

Path Parameter
"id" - expects a non-negative integer

Sortable Fields
"author_id"
"post_date" (default)
"message"

Response Data
An array of Reply objects.
​

Token Type
Private

Method/URL
POST https://api.builtbybit.com/v1/threads/{id}/replies

Path Parameter
"id" - expects a non-negative integer

Body Parameters
"message" - expects a string

Response Data
An unsigned integer representing the newly created reply's identifier.​