Employees

An Employee (Gigger) is an individual performing tasks within your organization, employed by Gigapay. To add an Employee to your organization you can create an Employee object. The Employee will be notified and Gigapay will verify their identity and working permits.

The Employee object

Attribute

Description

id

Unique identifier for the object.

name

The full name of the Employee.

email

Email address of the Employee.

country

Employee's country of residence. ISO-3166 country code.

cellphone_number

The Employees cellphone number, including country code.

metadata

JSON-encoded metadata.

created_at

Time at which the Employee was created at. Displayed as ISO 8601 string.

notified_at

Time at which the Employee was notified. Displayed as ISO 8601 string.

verified_at

Time when the Employee was verified. Displayed as ISO 8601 string.

post
Create an Employee

https://api.gigapay.se/v2/employees/
Endpoint for creating Employees.
Request
Response
Request
Headers
Authentication
required
string
Authentication token.
Integration-ID
required
string
Integration-ID.
Idempotency-Key
optional
string
Idempotency key.
Body Parameters
id
optional
string
Unique identifier for the object. If an identifier is not provided will an UUID4 be generated.
name
required
string
The full name of the Employee.
cellphone_number
optional
string
The Employee's cellphone number, including country code. Either cellphone_number or email is required.
email
optional
string
The Employee's email address. Either cellphone_number or emailis required.
country
required
string
The Employees country of residence. ISO-3166 country code.
metadata
optional
object
JSON-encoded metadata. If none is provided will an empty object be used.
Response
201: Created
Employee successfuly created.
{
"id": "1f1d1263-0e79-4787-b573-6df81b44bfc2",
"name": "Albin Lindskog",
"cellphone_number": "+46703000000",
"email": null,
"country": "SWE",
"metadata": {
"user_id": 2,
},
"created_at": "2019-05-22T10:32:36.118753Z",
"notified_at": null,
"verified_at": null,
}
400: Bad Request
Body contained an apparent error.
{
"non_field_errors": [
"Either email or cellphone_number is required."
]
}

get
List Employees

https://api.gigapay.se/v2/employees/
Endpoint for listing Employees. The Employees are returned sorted by creation date, with the most recently created Employee appearing first.
Request
Response
Request
Headers
Authentication
required
string
Authentication Token.
Integration-ID
required
string
Integration ID.
Query Parameters
page
optional
number
Which page to return.
page_size
optional
number
The number of Employees per page.
Response
200: OK
Employees successfully listed.
{
"count": 4,
"next": "https://api.gigapay.se/v2/employees/?page=2",
"previous": null,
"results": [
{
"id": "1f1d1263-0e79-4787-b573-6df81b44bfc2",
"name": "Albin Lindskog",
"cellphone_number": "+46703000000",
"email": null,
"country": "SWE",
"metadata": {
"user_id": 2,
},
"created_at": "2019-05-22T10:32:36.118753Z",
"notified_at: "2019-05-22T10:36:23.348293Z",
"verified_at": null,
}, {
"id": "25d2af38-59b9-4f73-9452-51787fed5c84",
"name": "Karl Karlsson",
"cellphone_number": null,
"email": karl.karlsson@gmail.com,
"country": "SWE",
"metadata": {
"user_id": 3,
},
"created_at": "2019-05-20T15:33:08.974624Z",
"notified_at: "2019-05-20T15:33:23.942843Z",
"verified_at": "2019-05-21T09:13:48.625263",
}
]
}

get
Retrieve an Employee

https://api.gigapay.se/v2/employees/:id/
Endpoint for retrieving a specific Employee.
Request
Response
Request
Path Parameters
id
required
string
The identifier of the Employee to be retrieved.
Headers
Authentication
required
string
Authentication Token.
Integration-ID
required
string
Integration ID.
Response
200: OK
Employee successfully retrieved.
{
"id": "25d2af38-59b9-4f73-9452-51787fed5c84",
"name": "Karl Karlsson",
"cellphone_number": null,
"email": karl.karlsson@gmail.com,
"country": "SWE",
"metadata": {
"user_id": 3,
}
"created_at": "2019-05-20T15:33:08.974624Z",
"notified_at: "2019-05-20T15:33:23.942843Z",
"verified_at": "2019-05-21T09:13:48.625263",
}

patch
Update an employees

https://api.gigapay.se/v2/employees/:id/
Endpoint for updating a specific Employee.
Request
Response
Request
Path Parameters
id
required
string
The identifier of the Employee to be updated.
Headers
Authentication
required
string
Authentication Token.
Integration-ID
required
string
Integration ID.
Body Parameters
id
optional
string
A new, unique identifier for the object. If one is not provided, the previous value will be retained.
name
optional
string
The full name of the Employee. If one is not provided, the previous value will be retained.
cellphone_number
optional
string
The Employees cellphone number. If one is not provided, the previous value will be retained.
email
optional
string
The email address of the Employee. If one is not provided, the previous value will be retained.
country
optional
string
The country of residence of the Employee. If one is not provided, the previous value will be retained.
metadata
optional
object
JSON-encoded metadata. If one is not provided, the previous value will be retained.
Response
200: OK
Employee sucessfully updated.
{
"id": "1f1d1263-0e79-4787-b573-6df81b44bfc2",
"name": "Albin Lindskog",
"cellphone_number": "+46703000005",
"email": null,
"country": "SWE",
"metadata": {
"user_id": 2,
},
"created_at": "2019-05-22T10:32:36.118753Z",
"verified_at": null,
"verified_at": null,
}
400: Bad Request
Body contained an apparent error.
{
"cellphone_number": [
"Enter a valid Swedish phone number."
]
}

put
Replace an Employee

https://api.gigapay.se/v2/employees/:id/
The endpoint for replacing a specific Employee.
Request
Response
Request
Path Parameters
id
required
string
The identifier of the Employee to be updated.
Headers
Authentication
required
string
Authentication Token.
Integration-ID
required
string
Integration ID.
Body Parameters
id
optional
string
A new, unique identifier for the object. If one is not provided, a UUID4 be generated.
name
optional
string
The full name of the Employee.
cellphone_number
optional
string
The Employees cellphone number, including country code. Either cellphone_numberor email is required.
email
optional
string
The Employee's email address. Either cellphone_number or email is required.
country
required
string
The Employees country of residence. ISO-3166 country code.
metadata
optional
object
JSON-encoded metadata. If none is provided will an empty map be used.
Response
200: OK
Employee successfully replaced.
{
"id": "132",
"name": "Thomas Brunner",
"cellphone_number": "+46703000002",
"email": null,
"country": "SWE",
"metadata": {
"user_id": 8,
},
"created_at": "2019-05-22T10:32:36.118753Z",
"notified_at": null,
"verified_at": null,
}
400: Bad Request
Body contained an apparent error.
{
"cellphone_number": [
"Enter a valid Swedish phone number."
]
}

delete
Delete an Employee

https://api.gigapay.se/v2/employees/:id/
Request
Response
Request
Path Parameters
id
required
string
The identifier of the Employee to be deleted.
Headers
Authentication
required
string
Authentication token.
Integration-ID
required
string
Integration-ID.
Response
204: No Content
Employee successfully deleted.