Glint Solar API (1.0.0)

Download OpenAPI specification:

REST API to create, read, update, and delete Glint Solar projects, parcels, contacts, and organizations.

Authentication uses a Personal Access Token sent in the X-API-Key header. See the Get Started guide.

Organizations

List organizations

Returns all organizations the authenticated user has access to.

Authorizations:

apiKey

Responses

Request samples

cURL
JavaScript
Python

curl -X GET "https://api.glintsolar.com/organizations/v1" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string"
}
]

Portfolios

List portfolios

Returns all portfolios in an organization that the user has access to.

Authorizations:

apiKey

query Parameters

orgId

required

string

Organization ID

Responses

Request samples

cURL
JavaScript
Python

curl -X GET "https://api.glintsolar.com/portfolios/v1?orgId=YOUR_ORG_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Response samples

200

Content type

application/json

[{"org_id": "string",
"id": "string",
"name": "string",
"created_at": "2019-08-24T14:15:22Z"
}
]

Users

List users

Returns all users in an organization, including organization members and guest users with portfolio access.

Authorizations:

apiKey

query Parameters

orgId

required

string

Organization ID

Responses

Request samples

cURL
JavaScript
Python

curl -X GET "https://api.glintsolar.com/users/v1?orgId=YOUR_ORG_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Response samples

200

Content type

application/json

[{"uid": "string",
"email": "user@example.com",
"name": "string",
"role": "admin"
}
]

Projects

List projects

Returns all projects in a portfolio with pagination support.

Authorizations:

apiKey

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID
limit	integer [ 1 .. 5000 ] Maximum number of projects to return.
startKey	string Pagination cursor from previous response

Responses

Request samples

cURL
JavaScript
Python

curl -X GET "https://api.glintsolar.com/projects/v1?orgId=YOUR_ORG_ID&portfolioId=YOUR_PORTFOLIO_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Response samples

200

Content type

application/json

{"items": [{"id": "string",
"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"nextKey": "string"
}

Create project

Creates a new project in a portfolio.

Authorizations:

apiKey

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID

Request Body schema: application/json
required

required

object

Responses

Request samples

Payload
cURL
JavaScript
Python

Content type

application/json

{"properties": {"name": {"text": "string"
},
"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
}
}

Response samples

200

Content type

application/json

{"id": "string",
"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get project schema

Returns the project schema with available properties for the organization.

Authorizations:

apiKey

query Parameters

orgId

required

string

Organization ID

Responses

Request samples

cURL
JavaScript
Python

curl -X GET "https://api.glintsolar.com/projects/v1/schema?orgId=YOUR_ORG_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Response samples

200

Content type

application/json

{"properties": [{"id": "string",
"name": "string",
"property_type": "text",
"select": {"options": [{"id": "string",
"name": "string",
"color": "string"
}
]
}
}
]
}

Update project

Updates properties of a project.

Authorizations:

apiKey

path Parameters

id

required

string

Project ID

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID

Request Body schema: application/json
required

properties

required

object

Responses

Request samples

Payload
cURL
JavaScript
Python

Content type

application/json

{"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
}
}

Response samples

200

Content type

application/json

{"id": "string",
"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete project

Deletes a project.

Authorizations:

apiKey

path Parameters

id

required

string

Project ID

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID

Responses

Request samples

cURL
JavaScript
Python

curl -X DELETE "https://api.glintsolar.com/projects/v1/YOUR_ID?orgId=YOUR_ORG_ID&portfolioId=YOUR_PORTFOLIO_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

List parcels linked to a project

Returns parcels linked to a project within the given portfolio.

Authorizations:

apiKey

path Parameters

id

required

string

Project ID

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID
limit	integer [ 1 .. 5000 ] Maximum number of parcels to return.
startKey	string Pagination cursor from previous response

Responses

Request samples

cURL
JavaScript
Python

curl -X GET "https://api.glintsolar.com/projects/v1/YOUR_ID/parcels?orgId=YOUR_ORG_ID&portfolioId=YOUR_PORTFOLIO_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Response samples

200

Content type

application/json

{"items": [{"id": "string",
"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"nextKey": "string"
}

List contacts linked to a project

Returns contacts linked to a project within the given portfolio.

Authorizations:

apiKey

path Parameters

id

required

string

Project ID

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID
limit	integer [ 1 .. 5000 ] Maximum number of contacts to return.
startKey	string Pagination cursor from previous response

Responses

Request samples

cURL
JavaScript
Python

curl -X GET "https://api.glintsolar.com/projects/v1/YOUR_ID/contacts?orgId=YOUR_ORG_ID&portfolioId=YOUR_PORTFOLIO_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Response samples

200

Content type

application/json

{"items": [{"id": "string",
"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"nextKey": "string"
}

Link a contact to a project

Links a contact to a project.

Authorizations:

apiKey

path Parameters

id

required

string

Project ID

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID

Request Body schema: application/json
required

contactId

required

string non-empty

Responses

Request samples

Payload
cURL
JavaScript
Python

Content type

application/json

{"contactId": "string"
}

Unlink a contact from a project

Unlinks a contact from a project.

Authorizations:

apiKey

path Parameters

id required	string Project ID
contactId required	string Contact ID

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID

Responses

Request samples

cURL
JavaScript
Python

curl -X DELETE "https://api.glintsolar.com/projects/v1/YOUR_ID/contacts/YOUR_CONTACT_ID?orgId=YOUR_ORG_ID&portfolioId=YOUR_PORTFOLIO_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Parcels

Get parcel schema

Returns the parcel schema with available properties for the organization.

Authorizations:

apiKey

query Parameters

orgId

required

string

Organization ID

Responses

Request samples

cURL
JavaScript
Python

curl -X GET "https://api.glintsolar.com/parcels/v1/schema?orgId=YOUR_ORG_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Response samples

200

Content type

application/json

{"properties": [{"id": "string",
"name": "string",
"property_type": "text",
"select": {"options": [{"id": "string",
"name": "string",
"color": "string"
}
]
}
}
]
}

Update parcel

Updates properties of a parcel.

Authorizations:

apiKey

path Parameters

id

required

string

Parcel ID

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID

Request Body schema: application/json
required

properties

required

object

Responses

Request samples

Payload
cURL
JavaScript
Python

Content type

application/json

{"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
}
}

Response samples

200

Content type

application/json

{"id": "string",
"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

List projects linked to a parcel

Returns projects linked to a parcel within the given portfolio.

Authorizations:

apiKey

path Parameters

id

required

string

Parcel ID

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID
limit	integer [ 1 .. 5000 ] Maximum number of projects to return.
startKey	string Pagination cursor from previous response

Responses

Request samples

cURL
JavaScript
Python

curl -X GET "https://api.glintsolar.com/parcels/v1/YOUR_ID/projects?orgId=YOUR_ORG_ID&portfolioId=YOUR_PORTFOLIO_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Response samples

200

Content type

application/json

{"items": [{"id": "string",
"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"nextKey": "string"
}

List contacts linked to a parcel

Returns contacts linked to a parcel within the given portfolio.

Authorizations:

apiKey

path Parameters

id

required

string

Parcel ID

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID
limit	integer [ 1 .. 5000 ] Maximum number of contacts to return.
startKey	string Pagination cursor from previous response

Responses

Request samples

cURL
JavaScript
Python

curl -X GET "https://api.glintsolar.com/parcels/v1/YOUR_ID/contacts?orgId=YOUR_ORG_ID&portfolioId=YOUR_PORTFOLIO_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Response samples

200

Content type

application/json

{"items": [{"id": "string",
"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"nextKey": "string"
}

Link a contact to a parcel

Links a contact to a parcel.

Authorizations:

apiKey

path Parameters

id

required

string

Parcel ID

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID

Request Body schema: application/json
required

contactId

required

string non-empty

Responses

Request samples

Payload
cURL
JavaScript
Python

Content type

application/json

{"contactId": "string"
}

Unlink a contact from a parcel

Unlinks a contact from a parcel.

Authorizations:

apiKey

path Parameters

id required	string Parcel ID
contactId required	string Contact ID

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID

Responses

Request samples

cURL
JavaScript
Python

curl -X DELETE "https://api.glintsolar.com/parcels/v1/YOUR_ID/contacts/YOUR_CONTACT_ID?orgId=YOUR_ORG_ID&portfolioId=YOUR_PORTFOLIO_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Contacts

List contacts

Returns all contacts in a portfolio with pagination support.

Authorizations:

apiKey

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID
limit	integer [ 1 .. 5000 ] Maximum number of contacts to return.
startKey	string Pagination cursor from previous response

Responses

Request samples

cURL
JavaScript
Python

curl -X GET "https://api.glintsolar.com/contacts/v1?orgId=YOUR_ORG_ID&portfolioId=YOUR_PORTFOLIO_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Response samples

200

Content type

application/json

{"items": [{"id": "string",
"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"nextKey": "string"
}

Create contact

Creates a new contact in a portfolio.

Authorizations:

apiKey

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID

Request Body schema: application/json
required

required

object

Responses

Request samples

Payload
cURL
JavaScript
Python

Content type

application/json

{"properties": {"first_name": {"text": "string"
},
"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
}
}

Response samples

200

Content type

application/json

{"id": "string",
"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get contact schema

Returns the contact schema with available properties for the organization.

Authorizations:

apiKey

query Parameters

orgId

required

string

Organization ID

Responses

Request samples

cURL
JavaScript
Python

curl -X GET "https://api.glintsolar.com/contacts/v1/schema?orgId=YOUR_ORG_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Response samples

200

Content type

application/json

{"properties": [{"id": "string",
"name": "string",
"property_type": "text",
"select": {"options": [{"id": "string",
"name": "string",
"color": "string"
}
]
}
}
]
}

Update contact

Updates properties of a contact.

Authorizations:

apiKey

path Parameters

id

required

string

Contact ID

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID

Request Body schema: application/json
required

properties

required

object

Responses

Request samples

Payload
cURL
JavaScript
Python

Content type

application/json

{"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
}
}

Response samples

200

Content type

application/json

{"id": "string",
"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete contact

Deletes a contact.

Authorizations:

apiKey

path Parameters

id

required

string

Contact ID

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID

Responses

Request samples

cURL
JavaScript
Python

curl -X DELETE "https://api.glintsolar.com/contacts/v1/YOUR_ID?orgId=YOUR_ORG_ID&portfolioId=YOUR_PORTFOLIO_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

List parcels linked to a contact

Returns parcels linked to a contact within the given portfolio.

Authorizations:

apiKey

path Parameters

id

required

string

Contact ID

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID
limit	integer [ 1 .. 5000 ] Maximum number of parcels to return.
startKey	string Pagination cursor from previous response

Responses

Request samples

cURL
JavaScript
Python

curl -X GET "https://api.glintsolar.com/contacts/v1/YOUR_ID/parcels?orgId=YOUR_ORG_ID&portfolioId=YOUR_PORTFOLIO_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Response samples

200

Content type

application/json

{"items": [{"id": "string",
"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"nextKey": "string"
}

List projects linked to a contact

Returns projects linked to a contact within the given portfolio.

Authorizations:

apiKey

path Parameters

id

required

string

Contact ID

query Parameters

orgId required	string Organization ID
portfolioId required	string Portfolio ID
limit	integer [ 1 .. 5000 ] Maximum number of projects to return.
startKey	string Pagination cursor from previous response

Responses

Request samples

cURL
JavaScript
Python

curl -X GET "https://api.glintsolar.com/contacts/v1/YOUR_ID/projects?orgId=YOUR_ORG_ID&portfolioId=YOUR_PORTFOLIO_ID" \
  -H "X-API-Key: YOUR_PERSONAL_ACCESS_TOKEN"

Response samples

200

Content type

application/json

{"items": [{"id": "string",
"properties": {"property1": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
},
"property2": {"date": {"start": "2019-08-24"
},
"labels": ["string"
],
"number": 0,
"people": ["string"
],
"select": ["string"
],
"text": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"nextKey": "string"
}

Glint Solar API (1.0.0)

Organizations

List organizations

Authorizations:

Responses

Request samples

Response samples

Portfolios

List portfolios

Authorizations:

query Parameters

Responses

Request samples

Response samples

Users

List users

Authorizations:

query Parameters

Responses

Request samples

Response samples

Projects

List projects

Authorizations:

query Parameters

Responses

Request samples

Response samples

Create project

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get project schema

Authorizations:

query Parameters

Responses

Request samples

Response samples

Update project

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete project

Authorizations:

path Parameters

query Parameters

Responses

Request samples

List parcels linked to a project

Authorizations:

path Parameters

query Parameters

Responses

Request samples

Response samples

List contacts linked to a project

Authorizations:

path Parameters

query Parameters

Responses

Request samples

Response samples

Link a contact to a project

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Unlink a contact from a project

Authorizations:

path Parameters

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required