The Project resource
A project is where all of the user, subscription, plan, device, and SIM information lives. Knowing your project name is crucial for set-up. Note that you will have a test and production environment.
Properties
- Name
object
- Type
- string
- Description
Type of object is always
project
.
- Name
id
- Type
- string
- Description
Globally unique identifier for the project.
Example:gigs
- Name
billing
- Type
- nullable object
- Description
- Configuration parameters for the project use of billing. Present when the Billing API is enabled.
- Name
consent
- Type
- nullable object PREVIEW
- Description
- Configuration parameters for the project's user consent collection. When absent, user consent is not checked or required.
- Name
deliveryMethods
- Type
- array
- Description
List of available delivery methods for consent requests.
- Name
createdAt
- Type
- string
- Description
Time when the project was created.
Example:2021-01-21T19:32:13Z
- Name
image
- Type
- nullable string PREVIEW
- Description
Small-resolution project icon with an aspect ratio of
1:1
.Example:https://a.gigscdn.net/p/gigs/icon.png
- Name
legal
- Type
- nullable object
- Description
- The legal address for the company that manages the project.
- Name
locales
- Type
- array
- Description
List of supported locales represented as IETF language tags, ordered by preference.
Example:en-US
- Name
name
- Type
- string
- Description
A human-readable name for the project.
Example:Gigs Connect
- Name
organization
- Type
- object
- Description
- Name
payments
- Type
- nullable object
- Description
- Configuration parameters for the project use of payments.
- Name
currency
- Type
- string
- Description
Three-letter ISO 4217 currency code representing the currency of the project. Must be a supported currency.
Example:USD
required- Name
mode
- Type
- string DEPRECATED
- Description
Deprecated
This property is deprecated and will be removed in the future. Use the root-level field
type
instead.The mode in which the payments operate.
Allowed values:live, test
required
- Name
subscriptionOwner
- Type
- string
- Description
Indicates which entity will be registered as the owner of the subscription with the providers. When
company
is selected the legal address associated with the project will be used for the registration.Allowed values:user, company
- Name
support
- Type
- nullable object
- Description
- Contact details for consumer support requests regarding the project.
- Name
email
- Type
- nullable string
- Description
A publicly available email address for consumer support requests regarding the project.
Example:support@gigs.com
required- Name
phoneNumber
- Type
- nullable string
- Description
A publicly available phone number in E.164 format for consumer support requests regarding the project.
Example:+12345678900
required
- Name
type
- Type
- string
- Description
Indicates whether this is a live or test project. In live projects, subscriptions are invoiced to your organization, and any payments and taxes are real. The type cannot be changed after project creation.
Example:live
Allowed values:live, test
- Name
billable
- Type
- boolean DEPRECATED
- Description
Deprecated
This property is deprecated and will be removed in the future. Use type instead.
Whether subscriptions in this project are invoiced to your organization.
Example:true
Response
{
"object": "project",
"id": "gigs",
"billing": {
"advanceInvoicingDays": 7,
"currency": "USD",
"paymentBehavior": "manual",
"taxBehavior": "exclusive"
},
"consent": {},
"createdAt": "2021-01-21T19:32:13Z",
"image": "https://a.gigscdn.net/p/gigs/icon.png",
"legal": {
"name": "Gigs Inc.",
"city": "New York City",
"country": "US",
"line1": "129 West 81st Street",
"line2": "Apartment 5A",
"postalCode": "10024",
"state": "NY"
},
"locales": [
"en-US"
],
"name": "Gigs Connect",
"organization": {
"object": "organization",
"id": "org_0SNlurA04kOdemVEMVZQBF",
"createdAt": "2021-02-01T13:21:30Z",
"name": "Gigs"
},
"payments": {
"currency": "USD",
"mode": "live"
},
"subscriptionOwner": "user",
"support": {
"email": "support@gigs.com",
"phoneNumber": "+12345678900"
},
"type": "live",
"billable": true
}
Retrieve the project credentials
Retrieve the credentials of an existing project.
Preview
This endpoint is currently in preview and might change in the future.
We’re excited to hear your feedback and ideas. Please send an email to support@gigs.com to share your thoughts.
Path Parameters
- Name
project
- Type
- string
- Description
The unique identifier for the project.
Example:gigs
required
Response Schemas
- Name
object
- Type
- string
- Description
Type of object is always
projectCredentials
.
required- Name
paymentsKey
- Type
- nullable string
- Description
Publishable API key for payment integration.
Example:pk_test_XXooYYauvdEDq12NiTphI7sa
required
Request
curl https://api.gigs.com/projects/{project}/credentials \
-X GET \
-H "Content-type: application/json" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json"
Response
{
"object": "projectCredentials",
"paymentsKey": "pk_test_XXooYYauvdEDq12NiTphI7sa"
}
Retrieve a project
Retrieves the details of an existing project accessible by the API client.
Path Parameters
- Name
project
- Type
- string
- Description
The unique identifier for the project.
Example:gigs
required
Response Schemas
- Name
object
- Type
- string
- Description
Type of object is always
project
.
required- Name
id
- Type
- string
- Description
Globally unique identifier for the project.
Example:gigs
required- Name
billing
- Type
- nullable object
- Description
- Configuration parameters for the project use of billing. Present when the Billing API is enabled.
required- Name
consent
- Type
- nullable object PREVIEW
- Description
- Configuration parameters for the project's user consent collection. When absent, user consent is not checked or required.
- Name
deliveryMethods
- Type
- array
- Description
List of available delivery methods for consent requests.
required- Name
createdAt
- Type
- string
- Description
Time when the project was created.
Example:2021-01-21T19:32:13Z
required- Name
image
- Type
- nullable string PREVIEW
- Description
Small-resolution project icon with an aspect ratio of
1:1
.Example:https://a.gigscdn.net/p/gigs/icon.png
required- Name
legal
- Type
- nullable object
- Description
- The legal address for the company that manages the project.
required- Name
locales
- Type
- array
- Description
List of supported locales represented as IETF language tags, ordered by preference.
Example:en-US
required- Name
name
- Type
- string
- Description
A human-readable name for the project.
Example:Gigs Connect
required- Name
organization
- Type
- object
- Description
required- Name
payments
- Type
- nullable object
- Description
- Configuration parameters for the project use of payments.
- Name
currency
- Type
- string
- Description
Three-letter ISO 4217 currency code representing the currency of the project. Must be a supported currency.
Example:USD
required- Name
mode
- Type
- string DEPRECATED
- Description
Deprecated
This property is deprecated and will be removed in the future. Use the root-level field
type
instead.The mode in which the payments operate.
Allowed values:live, test
required
required- Name
subscriptionOwner
- Type
- string
- Description
Indicates which entity will be registered as the owner of the subscription with the providers. When
company
is selected the legal address associated with the project will be used for the registration.Allowed values:user, company
required- Name
support
- Type
- nullable object
- Description
- Contact details for consumer support requests regarding the project.
- Name
email
- Type
- nullable string
- Description
A publicly available email address for consumer support requests regarding the project.
Example:support@gigs.com
required- Name
phoneNumber
- Type
- nullable string
- Description
A publicly available phone number in E.164 format for consumer support requests regarding the project.
Example:+12345678900
required
required- Name
type
- Type
- string
- Description
Indicates whether this is a live or test project. In live projects, subscriptions are invoiced to your organization, and any payments and taxes are real. The type cannot be changed after project creation.
Example:live
Allowed values:live, test
required- Name
billable
- Type
- boolean DEPRECATED
- Description
Deprecated
This property is deprecated and will be removed in the future. Use type instead.
Whether subscriptions in this project are invoiced to your organization.
Example:true
required
Request
curl https://api.gigs.com/projects/{project} \
-X GET \
-H "Content-type: application/json" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json"
Responses
{
"object": "project",
"id": "gigs",
"billing": {
"advanceInvoicingDays": 7,
"currency": "USD",
"paymentBehavior": "manual",
"taxBehavior": "exclusive"
},
"consent": {
"deliveryMethods": [
"emailLink"
]
},
"createdAt": "2021-01-21T19:32:13Z",
"image": "https://a.gigscdn.net/p/gigs/icon.png",
"legal": {
"name": "Gigs Inc.",
"city": "New York City",
"country": "US",
"line1": "129 West 81st Street",
"line2": "Apartment 5A",
"postalCode": "10024",
"state": "NY"
},
"locales": [
"en-US"
],
"name": "Gigs Connect",
"organization": {
"object": "organization",
"id": "org_0SNlurA04kOdemVEMVZQBF",
"createdAt": "2021-02-01T13:21:30Z",
"name": "Gigs"
},
"payments": {
"currency": "USD",
"mode": "live"
},
"subscriptionOwner": "user",
"support": {
"email": "support@gigs.com",
"phoneNumber": "+12345678900"
},
"type": "live",
"billable": true
}
List all projects
Returns a list of projects. The projects returned are sorted by creation date, with the most recently created projects appearing first.
Query Parameters
- Name
organization
- Type
- string
- Description
The unique identifier for the organization to be filtered by.
Example:org_0SNlurA04kOdemVEMVZQBF
- Name
after
- Type
- string
- Description
A cursor for use in pagination. The
after
parameter takes an object ID that defines the position in the list, only items immediately following the item with that ID will be returned.
- Name
before
- Type
- string
- Description
A cursor for use in pagination. The
before
parameter takes an object ID that defines the position in the list, only items immediately preceding the item with that ID will be returned.
- Name
limit
- Type
- integer
- Description
The limit of items to be returned in the list, between 0 and 200.
Default:10
>= 0
<= 200
Response Schemas
- Name
object
- Type
- string
- Description
Type of object is always
list
.
required- Name
items
- Type
- array
- Description
- List of objects of type `project`.
required- Name
moreItemsAfter
- Type
- nullable string
- Description
A unique identifier to be used as
after
pagination parameter if more items are available sorted after the current batch of items.
required- Name
moreItemsBefore
- Type
- nullable string
- Description
A unique identifier to be used as
before
pagination parameter if more items are available sorted before the current batch of items.
required
Request
curl https://api.gigs.com/projects \
-X GET \
-H "Content-type: application/json" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json"
Responses
{
"object": "list",
"items": [
{
"object": "project",
"id": "gigs",
"billing": {
"advanceInvoicingDays": 7,
"currency": "USD",
"paymentBehavior": "manual",
"taxBehavior": "exclusive"
},
"consent": {
"deliveryMethods": [
"emailLink"
]
},
"createdAt": "2021-01-21T19:32:13Z",
"image": "https://a.gigscdn.net/p/gigs/icon.png",
"legal": {
"name": "Gigs Inc.",
"city": "New York City",
"country": "US",
"line1": "129 West 81st Street",
"line2": "Apartment 5A",
"postalCode": "10024",
"state": "NY"
},
"locales": [
"en-US"
],
"name": "Gigs Connect",
"organization": {
"object": "organization",
"id": "org_0SNlurA04kOdemVEMVZQBF",
"createdAt": "2021-02-01T13:21:30Z",
"name": "Gigs"
},
"payments": {
"currency": "USD",
"mode": "live"
},
"subscriptionOwner": "user",
"support": {
"email": "support@gigs.com",
"phoneNumber": "+12345678900"
},
"type": "live",
"billable": true
}
],
"moreItemsAfter": null,
"moreItemsBefore": null
}