Collection
Fetch Collections
Create Collection
Delete Collection
Update Collection
This endpoint makes an HTTP POST request to create a new collection. The request body should include the type, name, category, description, payment fee, privacy status, delivery date, tags, and other information.
Request
type (string): The type of the collection.
name (string): The name of the collection.
category (string): The category of the collection.
description (string): A detailed description of the collection.
paymentFee (string): The payment fee for the collection. This is optional
isPrivate (boolean): Indicates if the collection is private, optional.
deliveryDate (string): The delivery date for the collection.
tags (array of strings): Tags associated with the collection.
isParentFunded (boolean): Indicates if the collection is parent funded, optional.
meta (object): Additional metadata for the collection, optional.
Response
The response will include a status, message, and data object. The data object will contain detailed information about the newly created collection, including its ID, creator details, name, category, description, payment fee, privacy status, delivery date, tags, status, and other relevant attributes.
_id (string): The ID of the collection.
creator (object): Details of the creator, including ID, first name, last name, role, type, profile, and other related information.
name (string): The name of the collection.
category (string): The category of the collection.
description (string): A detailed description of the collection.
paymentFee (number): The payment fee for the collection.
isPrivate (boolean): Indicates if the collection is private.
deliveryDate (string): The delivery date for the collection.
tags (array of objects): Tags associated with the collection, including ID, name, key, color, and type.
status (string): The status of the collection.
inviteAccepted (boolean): Indicates if the invite for the collection is accepted.
isParentFunded (boolean): Indicates if the collection is parent funded.
createdAt (string): The date and time when the collection was created.
updatedAt (string): The date and time when the collection was last updated.
The response may also include other attributes related to the collection, such as equity, owners, invites, attachments, ratings, recipient completed job status, progress, deletion status, funding request status, payout transactions, and other relevant details.
{"type":"job","name":"Testing Tracker","category":"Engineering","description":"Create New Snowfort landing page","paymentFee":"100","isPrivate":false,"deliveryDate":"2024-10-01","tags":["nextjs","nodejs","javascript"],"isParentFunded":true,"meta":{}}
POST /v1/collection HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 250
{
"type": "job",
"name": "Testing Tracker",
"category": "Engineering",
"description": "Create New Snowfort landing page",
"paymentFee": "100",
"isPrivate": false,
"deliveryDate": "2024-10-01",
"tags": [
"nextjs",
"nodejs",
"javascript"
],
"isParentFunded": true,
"meta": {}
}
OK
{
"status": "success",
"message": "OK",
"data": {
"_id": "680b921b03127a4fd7110efa",
"creator": {
"_id": "680b8f5b03127a4fd7110e38",
"firstName": "Mista",
"lastName": "Fultu",
"role": "user",
"type": "recipient",
"profile": {
"talent": {
"tags": [],
"tagsIds": [],
"availability": "available"
},
"verified": false
},
"isPrivate": false,
"score": 0,
"profileCompleteness": 0,
"socket": {
"status": "OFFLINE"
}
},
"name": "Test Collection",
"category": "Engineering",
"description": "Create New Snowfort landing page",
"equity": "0",
"collections": [],
"type": "job",
"owners": [],
"invites": [],
"attachments": [],
"attachmentData": [],
"tagsData": [
"nextjs",
"nodejs",
"javascript"
],
"tags": [
{
"_id": "680b921b03127a4fd7110eef",
"name": "nextjs",
"key": "nextjs",
"color": "#94a9e0",
"type": "tags"
},
{
"_id": "680b921b03127a4fd7110ef3",
"name": "nodejs",
"key": "nodejs",
"color": "#c8eca3",
"type": "tags"
},
{
"_id": "680b921b03127a4fd7110ef7",
"name": "javascript",
"key": "javascript",
"color": "#c4c6f0",
"type": "tags"
}
],
"status": "pending",
"inviteAccepted": false,
"payoutStatus": "awaiting",
"feePayoutStatus": "awaiting",
"paktFeePayoutStatus": "awaiting",
"paymentFee": 100,
"isPrivate": false,
"deliveryDate": "2024-10-01T00:00:00.000Z",
"ratings": [],
"recipientCompletedJob": false,
"score": 0,
"progress": 0,
"isDeleted": false,
"isFundingRequest": false,
"payoutTransactions": [],
"failedPayoutCount": 0,
"failedFeePayoutCount": 0,
"failedPaktFeePayoutCount": 0,
"isParentFunded": true,
"createdAt": "2025-04-25T13:46:03.319Z",
"updatedAt": "2025-04-25T13:46:03.319Z",
"__v": 0,
"totalChildCollectionsCount": 0,
"totalChildCollectionEscrowCount": 0
}
}
This endpoint retrieves a collection of data based on the provided query parameters.
Request
The following query parameters can be used, all are optional.
type
(string): The type of collection to retrieve.status
(string): The status of the collection items to retrieve.creator
(boolean): Indicates if the creator information should be included.receiver
(boolean): Indicates if the receiver information should be included.isPrivate
(boolean): Indicates if private collection items should be included.price
(string): The price range of the collection items to retrieve.search
(string): A keyword to search within the collection items.tags
(string): The tags to filter the collection items.meta.name
(string): The name to filter the collection items.escrowPaid
(boolean): Indicates if escrow payment status should be included.parent
(string): The ID of the parent collection item.
Response
The response will be in JSON format and will contain the following fields:
status
(string): The status of the response.message
(string): A message related to the response.data
(object): An object containing the collection data.data
(array): An array of collection items, each containing various fields such as_id
,creator
,name
,category
,description
,equity
,collections
,type
,owners
,invites
,attachments
,attachmentData
,tagsData
,tags
,status
,inviteAccepted
,payoutStatus
,feePayoutStatus
,paktFeePayoutStatus
,paymentFee
,isPrivate
,deliveryDate
,ratings
,recipientCompletedJob
,score
,progress
,isDeleted
,isFundingRequest
,payoutTransactions
,failedPayoutCount
,failedFeePayoutCount
,failedPaktFeePayoutCount
,isParentFunded
,createdAt
,updatedAt
,totalChildCollectionsCount
,totalChildCollectionEscrowCount
,isBookmarked
,bookmarkId
.
total
(number): The total count of items.pages
(number): The total number of pages.page
(number): The current page number.limit
(number): The limit of items per page.
slot
ongoing
true
true
false
10,1000
Olusegun
tag_one
john
false
680ba69c03127a4fd7110f40
GET /v1/collection HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "success",
"message": "OK",
"data": {
"data": [
{
"_id": "680b921b03127a4fd7110efa",
"creator": {
"_id": "680b8f5b03127a4fd7110e38",
"firstName": "Mista",
"lastName": "Fultu",
"role": "user",
"type": "recipient",
"profile": {
"talent": {
"tags": [],
"tagsIds": [],
"availability": "available"
},
"verified": false
},
"isPrivate": false,
"score": 0,
"profileCompleteness": 0,
"socket": {
"status": "OFFLINE"
}
},
"name": "Test Collection",
"category": "Engineering",
"description": "Create New Snowfort landing page",
"equity": "0",
"collections": [],
"type": "job",
"owners": [],
"invites": [],
"attachments": [],
"attachmentData": [],
"tagsData": [
"nextjs",
"nodejs",
"javascript"
],
"tags": [
{
"_id": "680b921b03127a4fd7110eef",
"name": "nextjs",
"key": "nextjs",
"color": "#94a9e0",
"type": "tags"
},
{
"_id": "680b921b03127a4fd7110ef3",
"name": "nodejs",
"key": "nodejs",
"color": "#c8eca3",
"type": "tags"
},
{
"_id": "680b921b03127a4fd7110ef7",
"name": "javascript",
"key": "javascript",
"color": "#c4c6f0",
"type": "tags"
}
],
"status": "pending",
"inviteAccepted": false,
"payoutStatus": "awaiting",
"feePayoutStatus": "awaiting",
"paktFeePayoutStatus": "awaiting",
"paymentFee": 100,
"isPrivate": false,
"deliveryDate": "2024-10-01T00:00:00.000Z",
"ratings": [],
"recipientCompletedJob": false,
"score": 0,
"progress": 0,
"isDeleted": false,
"isFundingRequest": false,
"payoutTransactions": [],
"failedPayoutCount": 0,
"failedFeePayoutCount": 0,
"failedPaktFeePayoutCount": 0,
"isParentFunded": true,
"createdAt": "2025-04-25T13:46:03.319Z",
"updatedAt": "2025-04-25T13:46:03.319Z",
"__v": 0,
"totalChildCollectionsCount": 0,
"totalChildCollectionEscrowCount": 0,
"isBookmarked": false,
"bookmarkId": ""
}
],
"total": 1,
"pages": 1,
"page": 1,
"limit": 12
}
}
This endpoint is used to delete a specific collection identified by the id
.
Request
id
(string): Represents the unique identifier of the collection to be deleted.
Response
status
(string): Indicates the status of the response.message
(string): Provides additional information about the status.data
(object): Contains the deleted collection data.
680ba69c03127a4fd7110f40
DELETE /v1/collection/{id} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "success",
"message": "OK",
"data": {}
}
This API endpoint is used to update the details of a specific collection.
Request
type
(string): The type of the collection.name
(string): The name of the collection.category
(string): The category of the collection.description
(string): The description of the collection.paymentFee
(string): The payment fee for the collection.isPrivate
(boolean): Indicates if the collection is private.deliveryDate
(string): The delivery date for the collection.tags
(array of strings): Tags associated with the collection.
Response
Upon making a successful request, the response will be a JSON object with the following schema:
status
(string): The status of the response.message
(string): Additional information or message related to the response.data
(object): An object containing the updated details of the collection with the following properties:_id
(string): The unique identifier of the collection.name
(string): The name of the collection.category
(string): The category of the collection.description
(string): The description of the collection.equity
(string): Indicates the equity of the collection.collections
(array): Array of collections associated with the main collection.type
(string): The type of the collection.owners
(array): Array of owners associated with the collection.invites
(array): Array of invites related to the collection.applications
(array): Array of applications associated with the collection.skillData
(array): Array of skill data related to the collection.skills
(array): Array of skills associated with the collection.status
(string): The status of the collection.inviteAccepted
(boolean): Indicates if the invite for the collection is accepted.payoutStatus
(string): The payout status of the collection.paymentStatus
(string): The payment status of the collection.feePayoutStatus
(string): The fee payout status of the collection.balanceStatus
(string): The balance status of the collection.paymentFee
(string): The payment fee for the collection.isPrivate
(boolean): Indicates if the collection is private.deliveryDate
(string): The delivery date for the collection.recipientCompletedJob
(boolean): Indicates if the recipient has completed the job.score
(number): The score associated with the collection.progress
(number): The progress of the collection.isDeleted
(boolean): Indicates if the collection is deleted.createdAt
(string): The date and time of creation of the collection.updatedAt
(string): The date and time of the last update to the collection.slug
(string): The slug associated with the collection.
67d97ade1e80a765d28e5b49
{"type":"job","name":"Create New Afrofund landing page Local","category":"Engineering","description":"Create New Afrofund landing page, Create New Afrofund landing page, Create New Afrofund landing page, Create New Afrofund landing page","paymentFee":"1000","isPrivate":false,"deliveryDate":"2023-10-01","tags":["nextjs","nodejs","javascript"]}
PATCH /v1/collection/{id} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 344
{
"type": "job",
"name": "Create New Afrofund landing page Local",
"category": "Engineering",
"description": "Create New Afrofund landing page, Create New Afrofund landing page, Create New Afrofund landing page, Create New Afrofund landing page",
"paymentFee": "1000",
"isPrivate": false,
"deliveryDate": "2023-10-01",
"tags": [
"nextjs",
"nodejs",
"javascript"
]
}
Accepted
{
"status": "success",
"message": "Accepted",
"data": {
"_id": "6492c4b5284692aba6276e37",
"name": "Local Jobs Test Five",
"category": "Engineering",
"description": "Create New Afrofund landing page",
"equity": "0",
"collections": [],
"type": "job",
"owners": [],
"invites": [],
"applications": [],
"skillData": [],
"skills": [
"6492c15802fc8ce075a39ea6",
"6492c15802fc8ce075a39eaa",
"6492c15902fc8ce075a39eae"
],
"status": "pending",
"inviteAccepted": false,
"payoutStatus": "awaiting",
"paymentStatus": "awaiting",
"feePayoutStatus": "awaiting",
"balanceStatus": "awaiting",
"paymentFee": "100",
"isPrivate": false,
"deliveryDate": "2023-01-31T21:00:00.000Z",
"recipientCompletedJob": false,
"score": 0,
"progress": 0,
"isDeleted": false,
"createdAt": "2023-06-21T09:36:54.027Z",
"updatedAt": "2023-06-21T09:36:54.027Z",
"slug": "local-jobs-test-five_dgy",
"__v": 0
}
}
This endpoint retrieves detailed information about a specific collection identified by its ID.
Request
No request body is required for this endpoint.
Response
The response will be a JSON object with the following schema:
status
(string) - The status of the response.message
(string) - A message related to the response.data
(object) - An object containing detailed information about the specific collection, including the following attributes:_id
(string) - The unique identifier of the collection.creator
(object) - Information about the creator of the collection, including their ID, first name, last name, role, type, profile, privacy status, score, profile completeness, and socket status.name
(string) - The name of the collection.category
(string) - The category of the collection.description
(string) - The description of the collection.equity
(string) - The equity associated with the collection.collections
(array) - An array of collections associated with the main collection.type
(string) - The type of the collection.owners
(array) - An array of owners associated with the collection.invites
(array) - An array of invites related to the collection.attachments
(array) - An array of attachments associated with the collection.attachmentData
(array) - An array of attachment data.tagsData
(array) - An array of tags data.tags
(array) - An array of tags, each containing an ID, name, key, color, and type.status
(string) - The status of the collection.inviteAccepted
(boolean) - Indicates whether the invite to the collection has been accepted.payoutStatus
(string) - The payout status of the collection.feePayoutStatus
(string) - The fee payout status of the collection.paktFeePayoutStatus
(string) - The Pakt fee payout status of the collection.paymentFee
(number) - The payment fee associated with the collection.isPrivate
(boolean) - Indicates whether the collection is private.deliveryDate
(string) - The delivery date of the collection.ratings
(array) - An array of ratings related to the collection.recipientCompletedJob
(boolean) - Indicates whether the recipient has completed the job related to the collection.score
(number) - The score associated with the collection.progress
(number) - The progress of the collection.isDeleted
(boolean) - Indicates whether the collection has been deleted.isFundingRequest
(boolean) - Indicates whether the collection is a funding request.payoutTransactions
(array) - An array of payout transactions related to the collection.failedPayoutCount
(number) - The count of failed payout transactions.failedFeePayoutCount
(number) - The count of failed fee payout transactions.failedPaktFeePayoutCount
(number) - The count of failed Pakt fee payout transactions.isParentFunded
(boolean) - Indicates whether the parent collection is funded.createdAt
(string) - The date and time when the collection was created.updatedAt
(string) - The date and time when the collection was last updated.__v
(number) - The version of the collection.totalChildCollectionsCount
(number) - The total count of child collections associated with the main collection.totalChildCollectionEscrowCount
(number) - The total escrow count of child collections associated with the main collection.
The data
object contains detailed information about the specific collection, including its creator, name, category, description, status, and other relevant attributes.
680b921b03127a4fd7110efa
GET /v1/collection/{id} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "success",
"message": "OK",
"data": {
"_id": "680b921b03127a4fd7110efa",
"creator": {
"_id": "680b8f5b03127a4fd7110e38",
"firstName": "Mista",
"lastName": "Fultu",
"role": "user",
"type": "recipient",
"profile": {
"talent": {
"tags": [],
"tagsIds": [],
"availability": "available"
},
"verified": false
},
"isPrivate": false,
"score": 0,
"profileCompleteness": 0,
"socket": {
"status": "OFFLINE"
}
},
"name": "Test Collection",
"category": "Engineering",
"description": "Create New Snowfort landing page",
"equity": "0",
"collections": [],
"type": "job",
"owners": [],
"invites": [],
"attachments": [],
"attachmentData": [],
"tagsData": [
"nextjs",
"nodejs",
"javascript"
],
"tags": [
{
"_id": "680b921b03127a4fd7110eef",
"name": "nextjs",
"key": "nextjs",
"color": "#94a9e0",
"type": "tags"
},
{
"_id": "680b921b03127a4fd7110ef3",
"name": "nodejs",
"key": "nodejs",
"color": "#c8eca3",
"type": "tags"
},
{
"_id": "680b921b03127a4fd7110ef7",
"name": "javascript",
"key": "javascript",
"color": "#c4c6f0",
"type": "tags"
}
],
"status": "pending",
"inviteAccepted": false,
"payoutStatus": "awaiting",
"feePayoutStatus": "awaiting",
"paktFeePayoutStatus": "awaiting",
"paymentFee": 100,
"isPrivate": false,
"deliveryDate": "2024-10-01T00:00:00.000Z",
"ratings": [],
"recipientCompletedJob": false,
"score": 0,
"progress": 0,
"isDeleted": false,
"isFundingRequest": false,
"payoutTransactions": [],
"failedPayoutCount": 0,
"failedFeePayoutCount": 0,
"failedPaktFeePayoutCount": 0,
"isParentFunded": true,
"createdAt": "2025-04-25T13:46:03.319Z",
"updatedAt": "2025-04-25T13:46:03.319Z",
"__v": 0,
"totalChildCollectionsCount": 0,
"totalChildCollectionEscrowCount": 0
}
}
This API endpoint is used to update the details of a specific collection.
Request
type
(string): The type of the collection.name
(string): The name of the collection.category
(string): The category of the collection.description
(string): The description of the collection.paymentFee
(string): The payment fee for the collection.isPrivate
(boolean): Indicates if the collection is private.deliveryDate
(string): The delivery date for the collection.tags
(array of strings): Tags associated with the collection.
Response
Upon making a successful request, the response will be a JSON object with the following schema:
status
(string): The status of the response.message
(string): Additional information or message related to the response.data
(object): An object containing the updated details of the collection with the following properties:_id
(string): The unique identifier of the collection.name
(string): The name of the collection.category
(string): The category of the collection.description
(string): The description of the collection.equity
(string): Indicates the equity of the collection.collections
(array): Array of collections associated with the main collection.type
(string): The type of the collection.owners
(array): Array of owners associated with the collection.invites
(array): Array of invites related to the collection.applications
(array): Array of applications associated with the collection.skillData
(array): Array of skill data related to the collection.skills
(array): Array of skills associated with the collection.status
(string): The status of the collection.inviteAccepted
(boolean): Indicates if the invite for the collection is accepted.payoutStatus
(string): The payout status of the collection.paymentStatus
(string): The payment status of the collection.feePayoutStatus
(string): The fee payout status of the collection.balanceStatus
(string): The balance status of the collection.paymentFee
(string): The payment fee for the collection.isPrivate
(boolean): Indicates if the collection is private.deliveryDate
(string): The delivery date for the collection.recipientCompletedJob
(boolean): Indicates if the recipient has completed the job.score
(number): The score associated with the collection.progress
(number): The progress of the collection.isDeleted
(boolean): Indicates if the collection is deleted.createdAt
(string): The date and time of creation of the collection.updatedAt
(string): The date and time of the last update to the collection.slug
(string): The slug associated with the collection.
67d97ade1e80a765d28e5b49
{"type":"job","name":"Create New Afrofund landing page Local","category":"Engineering","description":"Create New Afrofund landing page, Create New Afrofund landing page, Create New Afrofund landing page, Create New Afrofund landing page","paymentFee":"1000","isPrivate":false,"deliveryDate":"2023-10-01","tags":["nextjs","nodejs","javascript"]}
PATCH /v1/collection/{id} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 344
{
"type": "job",
"name": "Create New Afrofund landing page Local",
"category": "Engineering",
"description": "Create New Afrofund landing page, Create New Afrofund landing page, Create New Afrofund landing page, Create New Afrofund landing page",
"paymentFee": "1000",
"isPrivate": false,
"deliveryDate": "2023-10-01",
"tags": [
"nextjs",
"nodejs",
"javascript"
]
}
Accepted
{
"status": "success",
"message": "Accepted",
"data": {
"_id": "6492c4b5284692aba6276e37",
"name": "Local Jobs Test Five",
"category": "Engineering",
"description": "Create New Afrofund landing page",
"equity": "0",
"collections": [],
"type": "job",
"owners": [],
"invites": [],
"applications": [],
"skillData": [],
"skills": [
"6492c15802fc8ce075a39ea6",
"6492c15802fc8ce075a39eaa",
"6492c15902fc8ce075a39eae"
],
"status": "pending",
"inviteAccepted": false,
"payoutStatus": "awaiting",
"paymentStatus": "awaiting",
"feePayoutStatus": "awaiting",
"balanceStatus": "awaiting",
"paymentFee": "100",
"isPrivate": false,
"deliveryDate": "2023-01-31T21:00:00.000Z",
"recipientCompletedJob": false,
"score": 0,
"progress": 0,
"isDeleted": false,
"createdAt": "2023-06-21T09:36:54.027Z",
"updatedAt": "2023-06-21T09:36:54.027Z",
"slug": "local-jobs-test-five_dgy",
"__v": 0
}
}
Last updated