Get Program

GET 
https://platform.nativeframe.com/program/api/v1/projects/:projectID/programs/:id

Get program by ID

Generate JWT

Request

Path Parameters

id stringrequired

ID of the program

projectID stringrequired

ID of the project

Responses

200

Get program

application/json

Schema

Schema

idstring
projectIDstring
programNamestring
programSlugstringrequired
clientReferrerstring
defaultCompositionstring
modestring
createdBystring
updatedBystring
createdOnstring
updatedOnstring

Example (from schema)

{
  "id": "string",
  "projectID": "string",
  "programName": "string",
  "programSlug": "string",
  "clientReferrer": "string",
  "defaultComposition": "string",
  "mode": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "createdOn": "string",
  "updatedOn": "string"
}

404

Not Found

application/json

Schema

Schema

messagestringrequired

Error message for the end user

errorCodestring

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

namestringrequired

reasonstringrequired

errorCodestring

]

internalstring

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

500

Internal Server Error

application/json

Schema

Schema

messagestringrequired

Error message for the end user

errorCodestring

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

namestringrequired

reasonstringrequired

errorCodestring

]

internalstring

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

Authorization: http

name: JWTtype: httpscopes: aud:internal-account,service-account,roles:internal-account,service-accountscheme: bearerbearerFormat: JWTdescription: Bearer Token authentication for applications

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://platform.nativeframe.com/program/api/v1/projects/:projectID/programs/:id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://platform.nativeframe.com

Auth

Bearer Token

Parameters

id — pathrequired

projectID — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!